kickstart-nodejs v1.0.3

🚀 Kickstart Node.js

A CLI tool to generate a structured Node.js project with Express, MongoDB, and essential configurations.

📎 Features

• 📂 Pre-configured Folder Structure
• 🛠️ Express.js Integration
• 💾 MongoDB (Mongoose) Setup
• 🔧 Environment Variables (.env)
• ✅ Middleware & Utility Folders
• 🧩 Basic Test Script
• 📌 Auto Dependency Installation

🛠️ Installation

1️⃣ Install via npm

npm install -g kickstart-nodejs

2️⃣ Create a new Node.js project

kickstart-nodejs my-app

3️⃣ Navigate into the project

cd my-app

4️⃣ Install dependencies

npm install

5️⃣ Start the server

npm start

💁 Project Structure

my-app/
│-- src/
│   ├── config/          # Database configuration
│   ├── controllers/     # Controllers (business logic)
│   ├── models/          # Mongoose Models
│   ├── routes/          # Express Routes
│   ├── middlewares/     # Custom Middleware
│   ├── services/        # Reusable services
│   ├── utils/           # Utility functions
│-- tests/               # Test scripts
│-- server.js            # Main server file
│-- .env                 # Environment variables
│-- package.json         # Project metadata & dependencies
│-- .gitignore           # Ignore files like `node_modules`

🚀 API Routes

📝 Environment Variables

Before running, update the .env file with:

PORT=5000
MONGO_URI=your_mongo_connection_string

🤝 Contributing

1. Fork this repository.
2. Clone your forked repo.
3. Create a new branch (git checkout -b feature-name).
4. Make your changes and commit (git commit -m "Add new feature").
5. Push the branch (git push origin feature-name).
6. Open a Pull Request. 🎉

🐟 License

This project is MIT Licensed.

🚀 Happy Coding! 🎉

📢 How to Update Your README on npm

After updating README.md, publish the changes:

npm publish

If you only updated the README without changing the version, run:

npm publish --tag latest

This will update the README on npm without changing the version number. 🎉