Skip to content

Rest API in Node.js for a fictitious car rental company offering car rental services for the city of Rocketland.

License

Notifications You must be signed in to change notification settings

danielhesse/rentx-server

Repository files navigation

RentX Server

Badge

Description

RentX is a fictional car rental application that offers car rental services for a specific city, and in this repository you will find the project's back-end.

Main Techs

Code Standards

Getting Started

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

The project can be built directly with the Docker and Docker Compose, where the server container will be created with all the necessary configurations to start the project.

Also, it’s good to have an editor to work with the code like VSCode.

ℹ️ How to run

Follow the instructions below to download and use the project from this repository:

# Clone this repository using SSH
$ git clone git@github.com:daniel21h/rentx-server.git
# or clone using https
$ git clone https://github.com/daniel21h/rentx-server.git

# Go into the repository
$ cd rentx-server

# Run project in real-time
$ docker-compose up

# or run project in background
$ docker-compose up -d
# To see logs
$ docker logs rentx -f

Documentation

# To access the documentation
$ http://localhost:3333/api-docs

💻 How to connect

This project is still under development


Made with 💙 by Daniel Hessel 👋

About

Rest API in Node.js for a fictitious car rental company offering car rental services for the city of Rocketland.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages