README.md

🚙 A car rental API 🚙

About | Tecnologies | How to run | License

About the project

RentX is a NodeJS REST API for renting cars!

Tecnologies

• Typescript
• NodeJS
• Express
• Docker

Documentation

All API available endpoints are documented using Swagger. If you are running locally this API you can access the docs in http://localhost:3333/api-docs.

How to run

Clone Repo and install dependencies using yarn

$ git clone https://github.com/augustorl/rentx-api
$ cd rentx-api
$ yarn

Rename config files

$ mv ormconfig.json.exemple ormconfig.json
$ mv .env.exemple .env

Edit .env and ormconfig.json using your prefered IDE.

Run using docker or local server.

$ yarn dev # runs a local server
$ docker-compose up -d database # runs docker-compose.yml
$ yarn test # runs jest tests ang generates src/coverage
$ yarn build # Build to deploy

License

This project is under the MIT License. Read the LICENSE file for further information.