1.1.6 • Published 12 months ago

@cvyadnik/quicknode v1.1.6

Weekly downloads
-
License
ISC
Repository
-
Last release
12 months ago

šŸ“Œ 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.

1.1.6

12 months ago

1.1.5

12 months ago

1.1.4

12 months ago

1.1.3

12 months ago

1.1.2

12 months ago

1.1.1

12 months ago

1.0.0

12 months ago