| 1 | [](http://expressjs.com/)
|
| 2 |
|
| 3 | [Express'](https://www.npmjs.com/package/express) application generator.
|
| 4 |
|
| 5 | [![NPM Version][npm-image]][npm-url]
|
| 6 | [![NPM Downloads][downloads-image]][downloads-url]
|
| 7 | [![Linux Build][travis-image]][travis-url]
|
| 8 | [![Windows Build][appveyor-image]][appveyor-url]
|
| 9 | [![Gratipay][gratipay-image]][gratipay-url]
|
| 10 |
|
| 11 | ## Installation
|
| 12 |
|
| 13 | ```sh
|
| 14 | $ npm install -g express-generator
|
| 15 | ```
|
| 16 |
|
| 17 | ## Quick Start
|
| 18 |
|
| 19 | The quickest way to get started with express is to utilize the executable `express(1)` to generate an application as shown below:
|
| 20 |
|
| 21 | Create the app:
|
| 22 |
|
| 23 | ```bash
|
| 24 | $ express --view=hbs /tmp/foo && cd /tmp/foo
|
| 25 | ```
|
| 26 |
|
| 27 | Install dependencies:
|
| 28 |
|
| 29 | ```bash
|
| 30 | $ npm install
|
| 31 | ```
|
| 32 |
|
| 33 | Start your Express.js app at `http://localhost:3000/`:
|
| 34 |
|
| 35 | ```bash
|
| 36 | $ npm start
|
| 37 | ```
|
| 38 |
|
| 39 | ## Command Line Options
|
| 40 |
|
| 41 | This generator can also be further configured with the following command line flags.
|
| 42 |
|
| 43 | -h, --help output usage information
|
| 44 | --version output the version number
|
| 45 | -e, --ejs add ejs engine support
|
| 46 | --hbs add handlebars engine support
|
| 47 | --pug add pug engine support
|
| 48 | -H, --hogan add hogan.js engine support
|
| 49 | -v, --view <engine> add view <engine> support (dust|ejs|hbs|hjs|jade|pug|twig|vash) (defaults to jade)
|
| 50 | -c, --css <engine> add stylesheet <engine> support (less|stylus|compass|sass) (defaults to plain css)
|
| 51 | --git add .gitignore
|
| 52 | -f, --force force on non-empty directory
|
| 53 |
|
| 54 | ## License
|
| 55 |
|
| 56 | [MIT](LICENSE)
|
| 57 |
|
| 58 | [npm-image]: https://img.shields.io/npm/v/express-generator.svg
|
| 59 | [npm-url]: https://npmjs.org/package/express-generator
|
| 60 | [travis-image]: https://img.shields.io/travis/expressjs/generator/master.svg?label=linux
|
| 61 | [travis-url]: https://travis-ci.org/expressjs/generator
|
| 62 | [appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/generator/master.svg?label=windows
|
| 63 | [appveyor-url]: https://ci.appveyor.com/project/dougwilson/generator
|
| 64 | [downloads-image]: https://img.shields.io/npm/dm/express-generator.svg
|
| 65 | [downloads-url]: https://npmjs.org/package/express-generator
|
| 66 | [gratipay-image]: https://img.shields.io/gratipay/dougwilson.svg
|
| 67 | [gratipay-url]: https://gratipay.com/dougwilson/
|