Bootstrap a complete NodeJS App with babel, jest, Sequelize, JWT, GithHub action and docker already configured for you.
MIT License
Generate a complete NodeJS app (API) with babel, jest, Sequelize, JWT already configured for you.
Generate Node Project works on macOS, Windows, and Linux. If something doesn’t work, please file an issue. If you have questions or need help, please ask via email: [email protected]
npm i -g generate-node-project
or
yarn global add generate-node-project
generate-node-project new_node
cd new_node
npm start
You don’t need to install or configure tools like babel, eslint, sequelize, jest, mocha, mongodb, etc.... They are pre-configured and working, so that you can focus on the code.
Create a project, and you’re good to go.
You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine
To create a new app, you may choose one of the following methods:
generate-node-project new_node
create-node-api new_node
It will create a directory called new_node
inside the current folder.
Inside that directory, it will generate the initial project structure and install the required dependencies:
new_node
├── README.md
├── node_modules
├── package.json
├── .gitignore
├── .eslintrc
├── .jest.config.js
├── .env
├── app.js
├── index.js
├── __tests__
└── src
├── config
├── controllers
├── routes
├── models
├── migrations
└── seeders
Now all the configurations and folder structures are done for you. Once the installation is done, you can open your project folder:
cd new_node
Inside the newly created project, you can run some existing commands:
npm start
or yarn start
Runs the app in development mode. And it will be available on http://localhost:3000.
npm test
or yarn test
Runs the test.
Generate basic NodeJs API: javascript
generate-node-project app_name --skip
Generate basic NodeJs API: typscript
generate-node-project app_name --template=typescript
View all available commands
generate-node-project --help