https://github.com/expressjs/generator

Express' application generator
https://github.com/expressjs/generator

express generator javascript nodejs

Last synced: 7 days ago
JSON representation

Express' application generator

• Host: GitHub
• URL: https://github.com/expressjs/generator
• Owner: expressjs
• License: mit
• Created: 2013-11-20T22:24:21.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-08-20T15:32:48.000Z (5 months ago)
• Last Synced: 2024-10-29T09:08:17.284Z (3 months ago)
• Topics: express, generator, javascript, nodejs
• Language: JavaScript
• Size: 286 KB
• Stars: 1,824
• Watchers: 54
• Forks: 550
• Open Issues: 60
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome_npms - express-generator
• awesome-projects-boilerplates - Express Boilerplate
• stars - generator
• stars - generator

README

        
[![Express Logo](https://i.cloudup.com/zfY6lL7eFa-3000x3000.png)](http://expressjs.com/)

[Express'](https://www.npmjs.com/package/express) application generator.

[![NPM Version][npm-image]][npm-url]

[![NPM Downloads][downloads-image]][downloads-url]

[![Linux Build][github-actions-ci-image]][github-actions-ci-url]

[![Windows Build][appveyor-image]][appveyor-url]

## Installation

```sh

$ npm install -g express-generator

```

You can also run the application generator with the `npx` command (available since Node.js 8.2.0).

```sh

$ npx express-generator

```

## Quick Start

The quickest way to get started with express is to utilize the executable `express(1)` to generate an application as shown below:

Create the app:

```bash

$ express --view=hbs /tmp/foo && cd /tmp/foo

```

Install dependencies:

```bash

$ npm install

```

Start your Express.js app at `http://localhost:3000/`:

```bash

$ npm start

```

## Command Line Options

This generator can also be further configured with the following command line flags.

        --version        output the version number

    -e, --ejs            add ejs engine support

        --pug            add pug engine support

        --hbs            add handlebars engine support

    -H, --hogan          add hogan.js engine support

    -v, --view   add view  support (dust|ejs|hbs|hjs|jade|pug|twig|vash) (defaults to jade)

        --no-view        use static html instead of view engine

    -c, --css    add stylesheet  support (less|stylus|compass|sass) (defaults to plain css)

        --git            add .gitignore

    -f, --force          force on non-empty directory

    -h, --help           output usage information

## License

[MIT](LICENSE)

[npm-image]: https://img.shields.io/npm/v/express-generator.svg

[npm-url]: https://npmjs.org/package/express-generator

[appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/generator/master.svg?label=windows

[appveyor-url]: https://ci.appveyor.com/project/dougwilson/generator

[downloads-image]: https://img.shields.io/npm/dm/express-generator.svg

[downloads-url]: https://npmjs.org/package/express-generator

[github-actions-ci-image]: https://img.shields.io/github/workflow/status/expressjs/generator/ci/master?label=linux

[github-actions-ci-url]: https://github.com/expressjs/generator/actions/workflows/ci.yml