README.md

Locar - Containerized Car Rental Backend Service 🚗

🚀 Technologies   |    📃 Project   |    💻 How to execute   |    📝 License

🚀 Technologies

This project was developed using the following technologies:

• Node.js
• Express.js
• PostgreSQL
• Prisma ORM
• Redis
• JWT
• Rate Limiter Flexible

📃 Project

Locar is a backend service for car rental platforms, built using Node.js and Express.js. It includes essential features like user authentication, authorization, and rate limiting, with database support via PostgreSQL and Redis caching. Prisma is used for database migrations and seedings.

Key features include:

• JWT-based authentication
• User roles and permissions for authorization
• Rate limiting to protect against brute force attacks
• Database migrations and seeding with Prisma

💻 How to execute

Requirements

To follow the instructions below, you will need Git and Node.js installed.

Setting up the application

# Clone the repository
git clone https://github.com/yourusername/locar.git

# Access the project folder
cd locar

# Install all dependencies
yarn install

# Set up environment variables
cp .env.example .env

Database Setup

# Run database migrations
yarn db:migrate:dev

# Seed the database
yarn db:seed:dev

Starting the Application

# Start the application in development mode
yarn app:serve:dev

Accessing the Application

The server will start on http://localhost:3000 by default. You can use a tool like Postman to interact with the API endpoints.

📝 License

This repository are under MIT LICENSE. For detailed informations, read the file LICENSE.

---

Final Considerations

If you find any issue, please report it in the Issues section.

Feel free to contribute by making a Pull request!

Made by Aron Reis