🚀 Car Rental API

objective • roadmap • technologies • license • author

---

💡 Objective

RentX is a car rental API that uses a well-defined and highly modular architecture, it seeks to provide an efficient and reliable vehicle rental experience. With clear documentation provided by Swagger, RentX simplifies the rental process for users and developers.

🎌 Roadmap

Prerequisites

Before start to develop, you will need to have the following tools installed on your machine:

• Git
• Node
• Docker
• Yarn

You can also use npm, but i recommend yarn.

Also it's nice to have an editor to work with the code like VSCode.

Running the Back End (server)

🚫 Important

• A .env file must be created in the project's root folder containing all access keys, including to the databases.
• The .env.exemple file can be used as an example

Execute the commands

# Clone this repository
$ git clone https://github.com/mathmelo/rentx

# Access the project folder in the terminal/cmd
$ cd rentx

# Execute to create all containers and run the application
$ docker-compose up

# Enter the docker container and run migrations
$ docker exec -it bin/bash rentx
$ npm run migration:run


# The server will start on port:3333 - go to <http://localhost:3333>

📝 Docs

https://localhost:3333/docs

✅ Requirements

Click here

💜 Technologies

• Typescript
• NodeJS
• Express
• Postgres
• TypeORM
• Docker
• Swagger

📕 License

Read the license here.

🤓 Author

Informations about me. Send me a message! ;)

🚧 RentX 🚀 In construction... 🚧