quick-node-server
Version:
A CLI tool to generate a Node.js project with optional MongoDB setup.
52 lines (42 loc) ⢠1.32 kB
Markdown
# Quick Node Server
**Quick Node Server** is a CLI tool that helps you set up a Node.js project with Express.js and optional MongoDB configuration in just a few seconds.
## š Features
- Automatically generates a Node.js + Express.js project structure.
- Option to set up MongoDB connection.
- Pre-configured project with `dotenv`, `cors`, and `express`.
- Organized folder structure following best practices.
## š Project Structure
```
project-name/
āāā src/
ā āāā api/v1/
ā ā āāā controllers/
ā ā āāā routes/
ā ā āāā models/
āāā config/
ā āāā db.js
āāā .env
āāā package.json
āāā app.js
```
## š Installation
To install **Quick Node Server**, run the following command globally:
```sh
npm install -g quick-node-server
```
## ā” Usage
To create a new Node.js project, run:
```sh
quick-node-server myProject
```
Or using `npx` (without global installation):
```sh
npx quick-node-server myProject
```
This will create a new project folder `myProject` with the predefined structure.
### š” MongoDB Setup
If you choose to set up MongoDB, a connection file (`config/db.js`) will be generated automatically.
## š ļø License
This project is licensed under the MIT License.
## šØāš» Author
**Kartik Barman**