ArthurPMachado / RentalX

Repositório para explorar a criação de uma API em node, com princípos do SOLID e documentação com o Swagger

Car Rental App

A Node app to rental cars and with their images

The idea behind the project is for users to rental cars, for that the users can register the cars available with photos of them.

It's also a part of my personal portfolio, which I use to explore SOLID principles, API documentation, mail sending and attachments upload, which for them is used, respectively, SES and S3, both services from AWS

Technologies used

• NodeJS
• AWS
• TypeORM
• Docker
• Redis
• PostgreSQL
• JWT
• Jest
• Swagger

Getting Started

Prerequisites

To run this project, it's necessary to prepare your environment, which means:

1. Install NodeJS 16+ - https://nodejs.org/en
2. Download and install Docker - https://www.docker.com/products/docker-desktop/
3. To use all the features, it's necessary to have a AWS account, otherwise the storage and email-sending will not be possible - https://aws.amazon.com/

Installing

Cloning the Repository

$ git clone https://github.com/ArthurPMachado/RentalX.git

$ cd RentalX

Installing dependencies

$ yarn i

Running Project

$ yarn run dev

Running Tests

Unit tests

$ yarn run test

⚠️ DO NOT FORGET TO CREATE A .ENV FILE, OTHERWISE THE PROJECT WILL NOT WORK

Author

👤 Arthur Machado

• Github: @Arthur Machado
• LinkedIn: @Arthur Machado

Show your support

Give a ⭐️ if this project helped you!