: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

• [x] Generate Folder.
• [x] Generate Package.json.
• [x] Install yarn and babel packages(either one).
• [x] Generate Babel config(Babel 7).
• [x] Add babel absolute path resolution module.
• [x] Nodemon
• [x] Eslint

TODOS

• [ ] Editorconfig
• [ ] 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.
• [ ] Webpack, Parcel.
• [ ] Svgr and other handy cli's
• [ ] pm2 and cluster module for prod
• [ ] generic error handling and service bus
• [ ] Circuit breaker setup