Generator express
An Expressjs generator for Yeoman, based on the express command line tool.
Features
- Basic or MVC style file structure
- CoffeeScript Support
- Gulp or Grunt build tools with file watching and livereload
- .editorconfig for consistent coding styles within text editors
- Support View engines:
- Jade
- Handlebars
- Swig
- EJS
- Marko
- Nunjucks
- Supported CSS pre-processors
- SASS (both node-sass and ruby sass)
- LESS
- Stylus
- Supported Databases (with MVC structure):
- MongoDB
- MySQL
- PostgreSQL
- RethinkDB
- SQLite
Getting started
- Make sure you have yo installed:
npm install -g yo
- Install the generator globally:
npm install -g generator-express
- Run:
yo express
and select Basic. Add--coffee
if you require CoffeeScript. - Run:
grunt
orgulp
to run the local server atlocalhost:3000
, the grunt/gulp tasks include live reloading for views, css in public/css and restarting the server for changes to app.js or js in routes/
MVC apps
A generator for creating MVC style apps in express. Giving you the choice between the supported databases.
To get going:
- Make sure you have yo installed:
npm install -g yo
- Install the generator locally:
npm install generator-express
- Run:
yo express
, select MVC and select your database of choice. Add--coffee
if you require CoffeeScript. - Ensure that the selected database is running on your machine, if running elsewhere the connection string can be changed in
config/config.js
- Run:
grunt
orgulp
to run the local server - defaults tolocalhost:3000
- port can be changed inconfig/config.js
. The grunt/gulp tasks include live reloading as before.
Options
-
--coffee
Uses CoffeeScript.
-
--skip-install
Skips the automatic execution of
bower
andnpm
after scaffolding has finished.
Testing
Tests are written with mocha.
- Install:
npm install -g mocha
- Run:
mocha
ornpm test
Contributing
Contributors are welcome, please fork and send pull requests! If you have any ideas on how to make this project better then please submit an issue.