wladimirgrf / rentx

🚘 Car Rental | REST API with express

rentx

Project developed for the Rocketseat Ignite (Node.js Path). This application is a simple REST API and It was built to manage car rental routines.

🌍 Ecosystem

Below the technologies, used to build this API:

Name	Status

⚙️ Services

🧱 ERM

▶️ Getting started

Requirements

• Node.js
• Docker Compose

Clone the project

$ git clone https://github.com/wladimirgrf/rentx.git && cd rentx

Install the Project dependencies

$ npm install

Environment configuration

# Make a copy of '.env.sample'
# Fill both files with YOUR environment variables.
$ cp .env.sample .env
$ cp .env.sample .env.test

Run the containers

$ docker-compose up -d

Migrations

$ npm run typeorm migration:run

Launch the Application

$ npm run dev

The API will be launch at http://localhost:3333/
Documentation available at http://localhost:3333/api-docs

🤝 Contributing

Fork the repository and clone your fork

$ git clone fork-url && cd rentx

Create a branch for your edits

$ git checkout -b new-feature

Make the commit with your changes

$ git commit -m 'feat: New feature'

Send the code to your remote branch

$ git push origin new-feature

Create a pull request with your version.
After your pull request is merged, you can delete your branch.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.