https://github.com/petecoop/generator-express

An express generator for Yeoman, based on the express command line tool.
https://github.com/petecoop/generator-express

express nodejs yeoman-generator

Last synced: 8 days ago
JSON representation

An express generator for Yeoman, based on the express command line tool.

• Host: GitHub
• URL: https://github.com/petecoop/generator-express
• Owner: petecoop
• License: mit
• Archived: true
• Created: 2013-04-21T19:52:42.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-04-26T15:09:21.000Z (over 1 year ago)
• Last Synced: 2024-10-01T01:59:20.023Z (about 1 month ago)
• Topics: express, nodejs, yeoman-generator
• Language: JavaScript
• Size: 530 KB
• Stars: 814
• Watchers: 19
• Forks: 134
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - generator-express
• awesome-express - Yeoman express generator - generator-express - a yeoman generator (Tools)

README

        
## No Longer Maintained

This project has not been maintained since 2019 and is outdated. Please look for alternatives.

# Generator express

[![Build Status](https://img.shields.io/travis/petecoop/generator-express.svg)](https://travis-ci.org/petecoop/generator-express)

[![NPM Version](https://img.shields.io/npm/v/generator-express.svg)](https://www.npmjs.org/package/generator-express)

[![NPM Downloads](https://img.shields.io/npm/dm/generator-express.svg)](https://www.npmjs.org/package/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:

  - [Pug](https://pugjs.org/)

  - [Handlebars](http://handlebarsjs.com/)

  - [Swig](http://paularmstrong.github.io/swig/)

  - [EJS](http://ejs.co/)

  - [Marko](http://markojs.com/)

  - [Nunjucks](http://mozilla.github.io/nunjucks/)

- Supported CSS pre-processors

  - SASS

  - LESS

  - Stylus

- Supported Databases (with MVC structure):

  - MongoDB

  - MySQL

  - PostgreSQL

  - RethinkDB

  - SQLite

## Getting started

- Make sure you have [yo](https://github.com/yeoman/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](https://github.com/yeoman/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](http://en.wikipedia.org/wiki/MIT_License)