gocreating / seed-2

experimental version of seed

Seed

A flexible and scalable suite for building modern websites.

Features

• Node & Express 4
• React & Alt
• Isomorphic
• Sequalize
• Gulp
• Webpack
• React Router Component
• Hot reload react files
• Cross Platforms
• Support ES6/ES7 syntax

Prerequisites

• nodejs
• gulp

Nodejs and gulp must be installed. For the installation of nodejs, refer to nodejs official site. For installation of gulp, just use npm installation command:

$ npm install -g gulp

Getting started

$ npm install
$ gulp init -d  # initialize database or something else for development mode
$ gulp build -d # running the server as development mode

Initialize database

Create tables from schemas, and insert built-in records like root user, default permissions, etc.

-d, -t, and -p switches will initialize the development, test, production databases, respectively.

$ gulp init [-d | -t | -p]

Run as debug/production mode

• if you want to start developing your website, then use debug mode with livereload function.

  $ gulp build -d
  

• if you want to put your website into production, then use production mode.

  $ gulp build -p
  

• Moreover, you can turn on -u switch to uglify backend script files.

  $ gulp build -p -u
  

Open on browsers

• Development mode is host on port 5000

  http://localhost:5000

  and the livereload server is on port 8080

  http://localhost:8080

• Production mode is host on port 3000

  http://localhost:3000

Documentation

The documentation is served on gitbook site: seed

Others

Icon source: http://www.flaticon.com/free-icon/coffee-grains_2217

Development Gotchas

DON'T use arrow function syntax when defining model instanceMethods

see reference: babel/babel#733