• 1. About 💻
• 2. Application's links 🔗
• 3. General Functionalities ⚙️
• 4. Technologies 🧰
  • 4.1 Requisites ☑️
• 5. Developers' Team 🧑‍💻
• 6. Terms of Use 📜

Car Rentals is an application that focuses on finding a car to rent from a range of car rental companies choices.

The registered companies can register its own fleet of cars and make them available for customers to rent. The registered customers can pick a car to rent, choosing by price, model, among others.

The administrators of the application are allowed to suspend companies or customers activities based on bad reviews or others, making it impossible for them to rent a car.

This API was developed in order to storage administrators, customers and companies with their fleets of cars to rent data and to allow registered customers and companies to rent cars.

All routes require Bearer token authentication (except register and login for customers and companies). Access token can be obtained in login successful response.

This API contains 3 routes and 19 endpoints. For more detailed information about the API and its endpoints, please consult API Documentation in Application links section.

🎓 Project developed as first Capstone of Q4 back end module of the Fullstack Developer Course of Kenzie Academy Brasil.

• API Documentation (Swagger)
• API Deploy in Heroku

• Once registered in Car Rentals app and signed in, administrators can:

  • update their e-mail, name, password, phone number, CPF or address data;
  • register new administrators;
  • change customer's or company's status (available/unavailable for rent);
  • get administrators', customers' and companies' private profile information;
  • get a list of unavailable cars, deactivated by companies or that are already rented;
  • get rentals' history information or get a specific rental information;

• Once registered in Car Rentals app and signed in, companies can:

  • update their e-mail, name, password, CNPJ, address data or phone number;
  • register cars for rental;
  • get a list of owned cars;
  • update car's data, such as name, model, brand, year, color, doors, fuel type, plate, gear, chassis, current mileage, price per day of rental or rental availability.
  • make a car unavailable to rent;
  • filter its own cars for rental by rental availability;
  • get rentals' history;
  • get a customer or company public profile information;
  • close rental of a car;

• Once registered in Car Rentals app and signed in, customers can:

  • update their e-mail, name, password, CPF or CNPJ, address data or phone number;
  • retrieve a list of available cars for rental;
  • filter available cars for rental by name, model, brand, year, color, doors, fuel type, gear or rental price per day;
  • rent a car;
  • get car rental history;
  • get a company public profile information;

• TypeScript
• Node
• ExpressJS
• TypeORM
• PostgreSQL
• Jest
• Swagger API Specification

• PostgreSQL database;

Gustavo Lira

Larissa Oliveira

Raissa Toledo

Roberto Bressanelli

Sidney Patez

Tulio Goulart

This is an Open Source project for educational and non-commercial purposes.

License type: GPL