generator-stems
v1.1.0
Published
A Yeoman generator used to bootstrap Node.js micro-services
Downloads
1
Keywords
Readme
Stems - Generator
A Yeoman generator used to bootstrap Node.js micro-services.
Install Yeoman
To install the Yeoman CLI, run:
npm install -g yo
Install the generator
To install Stems from npm, run:
npm install -g generator-stems
Run the generator
Finally, initiate the generator:
yo stems
Generator options
Currently these are the options and their implications:
- Project Name
- Used for display purposes in logging and comments
- Converted to kebab-case, then used as the
name
field inpackage.json
as well as the file path inDockerfile
- Description
- Used as the
description
field inpackage.json
- Used as the
- Version
- Used as the
version
field inpackage.json
- Used as the
- Repo URL
- Used as the
repository.url
andhomepage
fields inpackage.json
- Suffixed with
/issues
to form thebugs
field inpackage.json
- Used as the
- Author
- Used as the
author.name
field inpackage.json
- Used as the
- Author's Email
- Used as the
author.email
field inpackage.json
- Used as the
- Public App?
- Private App?
- Sets up a Mongoose and Baucis based webapp with a default private config
- Amazon SWF?
- Sets up default directories and dependencies (like Usher) for Amazon SWF workflows, activities and deciders
- MongoDB?
- Sets up MongoDB access through Mongoose and default configurations
- Already included with Public and Private apps
- MongoDB is not included
Run tests
mocha