Project Overview

Welcome to the RentAPI repository! This project is part of a series of personal studies on Node.js, aimed at showcasing a range of advanced concepts and practical applications. The RentAPI is developed with TypeScript, adhering to the foundational principles of Clean Architecture and S.O.L.I.D. The project encompasses REST API design, file handling via streams, communication with PostgreSQL databases using TypeORM, injectable containers, JWT authentication with refresh tokens, and meticulous API documentation with Swagger. The application is fortified with automated tests, spanning both unit and integration levels, seamlessly integrated with the Jest Framework.

Check the API documentation on Swagger UI

Technical specification

• Design: Guided by Clean Architecture, Clean Code, Test Patterns, and S.O.L.I.D principles.
• Architecture: Powered by Express, Node.js, and TypeScript. Communicates seamlessly with PostgreSQL using TypeORM. Utilizes Jsonwebtoken for authentication and Nodemailer for efficient email communication.
  • Documentation Framework: Swagger ensures clear API documentation.
  • Testing Frameworks: Embraces Jest and Supertest for comprehensive testing.
• Infrastructure: Seamlessly integrates with AWS services like EC2, S3, and SES. Simplifies deployment through Docker.
• CI/CD: GitHub Actions streamline the development workflow.
• Security Measures: Rate-limiter-flexible and Redis enhance security and data management.

For deeper insights, delve into the project's wiki.

Running the RentAPI project locally

Follow these steps to get the RentAPI project up and running on your local machine:

1. Install Dependencies

Open a terminal and navigate to the project's root directory. Run the following command to install all required dependencies:

yarn

2. Set Up Database and Caching

Run the following command to create the PostgreSQL database and Redis images necessary for the project:

docker-compose up

3. Run Migrations

After setting up the database, execute the following command to run all migrations and set up the database schema:

yarn run typeorm migration:run

4. Populate Database

Populate the database with an admin user by running the following command:

yarn run seed:admin

This step ensures that you have initial data for testing and development.

5. Start the Server

To start the server and launch the application, use the following command:

yarn dev

With these steps completed, you'll have the RentAPI project running on your localhost, ready for exploration, testing, and development. Feel free to dive into the codebase and API documentation.

Running the tests locally

Run the following command to test:

yarn test

Tests scenarios

• [Accounts] should be able to authenticate an user
• [Accounts] should not be able to authenticate a nonexistent user
• [Accounts] should not be able to authenticate a user with wrong password
• [Accounts] should be able to send forgot password mail to user
• [Cars] should be able to create a new car
• [Cars] should not to be able to create a car with an existent license plate
• [Cars] should be able to create a new car with available true by default
• [Cars] should not be able to add a new specification to a non-existent car
• [Cars] should be able to add a new specification to an existent car
• [Cars] should be able to create a new category
• [Cars] should not be able to create a new category if already exists
• [Cars] should be able to list all available cars
• [Cars] should be able to list all available cars by name
• [Cars] should be able to list all available cars by brand
• [Cars] should be able to list all available cars by category_id
• [Cars] should be able to list all categories
• [Rentals] should be able to create a new rental
• [Rentals] should not be able to create a new rental if there is another open to the same user
• [Rentals] should not be able to create a new rental if there is another open to the same car
• [Rentals] should not be able to create a new rental with invalid return time