VH-Manager - Fleet Management System RESTful API

VH-Manager is a RESTful API for Fleet Management System. This system enables the company to manage all the resources of the fleet as well as the vehicle booking managment. the system composed by:

• Vehicles management
• Drivers management
• Fuels consumption management
• Vehicle expenses management
• Vehicle bookings management
• Customers maangement

Built With

• NestJS a progressive Node.js framework built with TypeScript
• Prisma Next-generation Node.js and TypeScript ORM
• Postgres Open Source Relational Database
• JWT standard for signature and optional encryption
• Swagger tools for documenting RESTful APIs

Installation

Installation with docker

Install docker on Mac, Windows or Linux https://docs.docker.com/get-docker/ For Linux you need to install docker compose separately here https://docs.docker.com/compose/install/

# Get the latest snapshot
$ git clone https://github.com/Adib128/vh-manager.git
# Change directory
$ cd vh-manager
# Rename the .env example file
$ mv .env.example .env
# Runing the docker container
$ docker-compose up

Now if you go to http://localhost:3000/api-docs/, you'll get

Installation without docker

You can install the project on your own server.

# Get the latest snapshot
$ git clone https://github.com/Adib128/vh-manager.git
# Change directory
$ cd vh-manager
# Rename the .env example file
$ mv .env.example .env
# Install NPM dependencies
$ npm install
# Then simply start the project
$ npm run start

Documentation

You'll find the API documentation here https://vh-manager.herokuapp.com/api-docs/.