1.0.3 • Published 3 years ago
generator-nodejs-pink v1.0.3
Generator NodeJS
Generator NodeJS is a generic scaffolding system allowing the creation of any kind of app. It allows for rapidly getting started on new projects and streamlines the maintenance of existing projects. It is based on Yeoman
Overview
This generator creates a NodeJs server on port 8080 with:
- Cors
- Dotenv
- Eslint
- Express
- Express rate limit
- Helmet
- Jest
- Morgan
- Nodemon
- Prettier
- Supertest
- Webpack
- Winston
Project generated:
├─── configs
.env
.env.development
.env.staging
.env.production
├─── dist
├─── src
├─── controllers
├─── middlewares
├─── models
├─── services
├─── tests
├─── functional
├─── integration
├─── smoke
├─── unit
test.config.json
├─── utils
├─── error
custom.error.js
handler.error.js
├─── log
app.js
routes.js
server.js
.eslintrc.json
.prettierrc
README.md
webpack.config.json
Getting started
- Install yeoman:
npm install -g yo
- Clone this project
- Download dependencies:
npm install
- Create a symlink locally for the generator:
npm link
- Create a folder for the project:
mkdir /project-test && cd /project-test
- Run starter command:
yo generator-nodejs-pink
Commands
Important: all commands must be executed at root level.
- Create project:
yo generator-nodejs-pink --name=my-project --description="Description project" --repository="https://example.com/path/my-project" --license=ISC
- Create a route:
yo generator-nodejs-pink:route verb /path ctrlName fncName [--cE=true]
- Create controller:
yo generator-nodejs-pink:controller ctrlName [--f=fncName]
- Create service:
yo generator-nodejs-pink:service servName [--f=fncName]
- Create model:
yo generator-nodejs-pink:model modName [--f=fncName]
Debug
To debug any command (including the initial) on VS Code:
1. Attach debugger to Node.JS process or edit .vscode/launch.json
and add the follow block:
{
"version": "0.2.0",
"configurations": [
{
"name": "Attach",
"port": 9229,
"request": "attach",
"skipFiles": [
"<node_internals>/**"
],
"type": "pwa-node"
}
]
}
- Execute:
node --inspect-brk %AppData%\npm\node_modules\yo\lib\cli.js nodejs[:command params]