UNPKG

quick-node-server

Version:

A CLI tool to generate a Node.js project with optional MongoDB setup.

52 lines (42 loc) • 1.32 kB
# 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**