Ignite - RentalX

An car rent API developed during Ignite course.

---

Index

• Index.
• About.
• Requirements.
• Installation.
• How to use.
  • Running server.
• Technologies.
• License.
• Author.

---

About

This project is a car rent API and was developed during Ignite course 👨🏽‍🚀 by RocketSeat 🚀💺💜.

---

Requirements

To run this project, please install this:

• NodeJS.
• TypeScript.
• Docker.

---

Installation

Clone the repo.

# Clone this repository
$ git clone https://github.com/FelipePardim/ignite-rentalx

Follow these steps to run the project.

---

How to use

🖥️ Running backend (server).

# Access the API folder.
$ cd ignite-rentalx

# Install dependencies.
$ yarn
#or.
$ npm install

# Start the API server.
$ yarn dev
#or.
$ npm dev

# The back-end server will listen on port 3333.
# Make API calls on http://localhost:3333.

---

🛠 Technologies

This are the tech stack and tools utilized to develop this project:

• NodeJS.
• TypeScript.
• Docker.

---

👨🏽‍💻 Author: