πWelcome to the Unleashed API project. This API allows you to create, read, update, and delete blog articles through a simple and reliable API.
This project is built using the following technologies:
- Node.js: A powerful JavaScript runtime environment.
- Express: A lightweight Node.js framework for building web applications and APIs.
- Prisma: An Object-Relational Mapping (ORM) that simplifies database interactions.
- Database: This project is designed to work with various databases supported by Prisma (e.g., PostgreSQL, MySQL).
- Create, read, update, and delete blog articles.
- Manage article categories.
- User authentication and role-based authorization.
- Clean and easy-to-use JSON format for the API.
- User management, including registration and login.
- Strong data validation and error handling.
To get started with the Unleashed API project, follow these steps:
- Clone the repository to your local machine
- Install the required dependencies using
npm install
- Configure environment variables according to your database settings and other preferences. Copy the .env.example file to .env and customize its contents.
- Run the project
npm start
This project provides various API endpoints for managing blog articles and users. Please refer to the API Documentation for more information on usage and available endpoints.
This project uses authentication with JSON Web Tokens (JWT). Make sure to obtain a token after logging in and include the token in the header every time you access endpoints that require authentication.
The project includes unit tests to ensure reliability and security. You can run the tests using the following command
npm test
This API can be deployed on various platforms, including cloud services like AWS, Heroku, or your own server infrastructure. Ensure you configure environment variables and settings correctly for production deployment.