generator-express-custom-boilerplate v0.0.7

:tada: generator-express :zap: :hammer_and_pick:

For using the generator

Pre-requisites

:star: Node(lts) and npm.

:star: Install yeoman globally using npm i -g yo.

Run generator

:label: Install using npm i -g generator-express-custom-boilerplate

:label: Run yo generator-express-custom-boilerplate in the desired folder

:label: Answer the questions in prompt or pass options from cli.

:label: For help in checking available options use command yo generator-express-custom-boilerplate --help

Running the project locally

Pre-requisites

:star: Node, npm, yeoman(globally installed).

:star: Yarn npm i -g yarn.

Steps

:label: Clone the repo.

:label: Install dependencies using yarn install.

:label: Run the command yarn build(This will compile the typescript code to es5).

:label: Run npm link from root directory of project(This will link the generator to yeoman).

:label: Switch to any other folder and run yo generator-express-custom-boilerplate

Feature List

• Generate Folder.
• Generate Package.json.
• Install yarn and babel packages(either one).
• Generate Babel config.
• Generate Editorconfig.
• Generate Eslintconfig.

TODOS

• Docker setup.
• Options to setup one or more tools
• Project structure generation.
• Unit test setup.
• Optional database setup.
• express module generation.
• flow config.
• setup declarative validations using Joi.
• Add envs and configs.
• Add travisci and jenkins.
• Coveralls integrations.
• Add Badges.
• Auto generate README.
• Setup absolute path generation.
• Babel plugin configs as per latest es standard.
• Setup wrapper logger and base error handler.
• Setup express app loaders and integration test.
• Setup swagger.
• Express middlewares and global error handling.
• Error handling framework, logging framework based on bunyan.