Skip to content
An express generator for Yeoman, based on the express command line tool.
JavaScript CoffeeScript HTML CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows github action ci (#243) Oct 24, 2019
app fixed sqlite db path (#239) Oct 25, 2019
test
.dependencies.json Fix tests & remove travis (#245) Oct 25, 2019
.editorconfig initial commit Apr 21, 2013
.eslintrc.js update code style Oct 19, 2017
.gitattributes
.gitignore fix tests Oct 24, 2016
.npmignore
LICENSE update copyright year Oct 19, 2017
README.md fixed identation (#235) Apr 7, 2019
package.json remove insights (#244) Oct 25, 2019
yarn.lock remove insights (#244) Oct 25, 2019

README.md

Generator express

Build Status NPM Version NPM Downloads

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:
  • Supported CSS pre-processors
    • 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 or gulp to run the local server at localhost: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 or gulp to run the local server - defaults to localhost:3000 - port can be changed in config/config.js. The grunt/gulp tasks include live reloading as before.

Options

  • --coffee

    Uses CoffeeScript.

  • --skip-install

    Skips the automatic execution of npm after scaffolding has finished.

Testing

Tests are written with mocha.

  • Install: npm install -g mocha
  • Run: mocha or npm 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.

License

MIT License

You can’t perform that action at this time.