1.0.3 • Published 4 months ago

kickstart-nodejs v1.0.3

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

šŸš€ 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

MethodEndpointDescription
GET/api/usersGet all users

šŸ“ 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. šŸŽ‰

1.0.3

4 months ago

1.0.2

4 months ago

1.0.0

4 months ago