Have ideas to improve npm?Join in the discussion! »

    generator-express-custom-boilerplate

    0.0.7 • Public • Published

    🎉 generator-express ⚡️ ⚒

    For using the generator

    Pre-requisites

    ⭐️ Node(lts) and npm.

    ⭐️ Install yeoman globally using npm i -g yo.

    Run generator

    🏷 Install using npm i -g generator-express-custom-boilerplate

    🏷 Run yo generator-express-custom-boilerplate in the desired folder

    🏷 Answer the questions in prompt or pass options from cli.

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

    Running the project locally

    Pre-requisites

    ⭐️ Node, npm, yeoman(globally installed).

    ⭐️ Yarn npm i -g yarn.

    Steps

    🏷 Clone the repo.

    🏷 Install dependencies using yarn install.

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

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

    🏷 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.

    Install

    npm i generator-express-custom-boilerplate

    DownloadsWeekly Downloads

    1

    Version

    0.0.7

    License

    ISC

    Unpacked Size

    7.24 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar