A npm project initializer to scafold a project and include basic tools like lint, testing, etc.
MIT License
An npm initializer to scaffold a node project and include basic tools like lint, testing, etc.
npm init <initializer>
can be used to set up a new or existing npm package.initializer
in this case is an npm package namedcreate-<initializer>
, which will be installed bynpx
, and then have its main bin executed -- presumably creating or updatingpackage.json
and running any other initialization-related operations. — Source:docs.npmjs.com
npm >= 6.5
node >= 10.12.0
npm install -g create-nodejs-project
create-nodejs-project setup
You will be prompted for your Github information If you do not have the information at the moment, you can keep it empty. In order to create projects with Github integration, you will need to add the authentication information later. See Github Auth
npm init nodejs-project path/to/new/project
Every time that I start a new project in Node.js, I hate to go to other project folder, copy files like eslintrc, editorconfig; install the same dependencies, create folder structure, etc.
With this in mind, the motivation to build this package started as a DRY (Do not repeat yourself) thing.
This package is intended to automated the initialization of new Node.js projects and with this have a new folder with everything ready to work, basically an scaffolding tool.
If you are planning to allow this script to create your Github repositories, is required to generate a Github Token.
Token Description: (your computer name)
Scopes:
[X] repo
[X] repo:status
[X] repo_deployment
[X] public_repo
[X] repo:invite
# nano /YOUR-NODE_MODULES-PATH/create-nodejs-project/create-nodejs-settings.json
...
...
"githubAuth": {
"user": "YOUR_USER",
"token": "YOUR_TOKEN"
}
...
...