📌 QuickNode CLI

🚀 QuickNode is a simple Node.js CLI tool that helps you quickly scaffold a Node.js + Express project with a database of your choice.

📥 Installation

To install QuickNode globally from npm, run:

npm install -g @cvyadnik/quicknode

🚀 Usage

Once installed, you can create a new project by running:

quicknode

Then, follow the interactive prompts:

1️⃣ Enter your project name
2️⃣ Select a database (MongoDB, MySQL, PostgreSQL, SQLite)

After that, QuickNode will:

• Set up the project folder structure 🏗️
• Create necessary configuration files 📂
• Install all dependencies automatically 📦
• Get your project ready for development 🚀

▶️ Run Your Project

Once your project is created, navigate into the directory:

cd your-project-name

Start the development server:

npm run dev

Or start it in production mode:

npm start

🛠 Folder Structure

Your project will be generated with the following structure:

your-project-name/
│── src/
│   ├── config/         # Database configurations
│   ├── controllers/    # Business logic
│   ├── models/         # Database models
│   ├── routes/         # API routes
│   ├── services/       # Reusable services
│   ├── middlewares/    # Express middlewares
│   ├── utils/          # Utility functions
│   ├── validations/    # Request validations
│   ├── logs/           # Log files
│   ├── app.js          # Express app setup
│   ├── server.js       # Server entry point
│── .env                # Environment variables
│── package.json        # Project metadata
│── README.md           # Documentation

🛠 Supported Databases

QuickNode supports the following databases:

• MongoDB (Mongoose)
• MySQL (Sequelize)
• PostgreSQL (Sequelize)
• SQLite (Sequelize)

✅ Updating QuickNode

If a new version is released, update it with:

npm update -g @cvyadnik/quicknode

🤝 Contributing

Feel free to fork this repository, submit pull requests, or open issues for feature requests!

📃 License

This project is MIT licensed.