n.js-quick-api v1.0.9
node-quick-api
node-quick-api is a lightweight framework designed to help students create APIs quickly and easily using Node.js and Express. This framework simplifies the process of setting up a RESTful API by providing a structured approach and essential tools.
Features
- Express Framework: A minimal and flexible Node.js web application framework.
- Sequelize: An ORM for Node.js that supports various SQL dialects.
- Validation: Built-in validation using Joi.
- File Uploads: Easy file uploads with Multer.
- Authentication: Secure user authentication with Bcrypt and JSON Web Tokens.
- Environment Management: Configuration management using dotenv.
- CORS Support: Cross-Origin Resource Sharing enabled by default.
- Modular Structure: Organized file structure for controllers, models, routes, middlewares, and utilities.
Installation
To get started with node-quick-api, follow these steps:
Clone the repository:
git clone https://github.com/yourusername/node-quick-api.git
Navigate to the project directory:
cd node-quick-api
Install the dependencies:
npm install
Set up your environment variables in the
.env
file.Run the application:
npm start
Usage
After setting up your project, you can define your API routes in the src/routes/index.js
file and implement your business logic in the corresponding controllers located in src/controllers/index.js
.
API Documentation
Refer to the src/routes/index.js
file for the available API endpoints and their usage.
Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue for any enhancements or bug fixes.
License
This project is licensed under the MIT License. See the LICENSE file for more details.