Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 1.62 KB

README.md

File metadata and controls

62 lines (40 loc) · 1.62 KB

generator-areus NPM version Build Status

Opinionated scaffolding tool for quickly generating a new express.js app with logical defaults.

The major architecture pieces include:

  1. express.js - routing
  2. react or dustjs - view engine
  3. gulp.js - task manager
  4. bunyan - logging
  5. nconf - configuration

Install

Requires node.js and npm

npm install -g yo generator-areus

Usage: App

Make a new directory, and cd into it:

mkdir my-new-project && cd $_

Run the generator:

yo areus

Once generation is complete, open the generated readme.md for instructions on how to use the app.

Usage: Module

Generates a new shared module to be published to the npm registry and shared between apps.

Make a new directory, and cd into it:

mkdir my-new-project && cd $_

Run the generator:

yo areus:module

Once generation is complete, you can reference it in your app locally (while developing) using npm link.

License

MIT