kncp (K Node Create Project)

By using this command you can easily create a node project without writing any code and with some dependencies installed. So you don't need to write any boilerplate code and then making directories and files for your project. kncp will take care of everything.

Prerequisite

-> Node must be installed.

Installation

Use the package manager npm to install kncp globally.

npm install kncp -g

| INFO: Install this package globally so that you can make node projects in future also without installing kncp again and again. | | ------------------------------------------------------------------------------------------------------------------------------ |

Which files with code will be included in your project ?

-> Database config file -> User Model file -> User controller file -> User routes -> Database Error handler file -> Middlerware authentication file -> Main server file

Which dependencies will be installed in your project ?

Dependencies:

1. bcryptjs
2. express
3. express-validator
4. jsonwebtoken
5. lodash
6. mongoose

DevDependencies:

1. concurrently
2. nodemon

Usage

kncp [Project_Name]

Example

kncp books_api

Output

-> The following directories and files will be created with some predefined code.

How to run the project ?

1. Replace YOUR_MONGODB_URI with your mongoDB url in ./config/db.js file.
2. On your shell write

npm run server

3. 😊 Enjoy...

License

MIT