mugishap / lendors-backend

Backend for car renting site

Home Page:https://lendors.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Lendors

Status GitHub Issues GitHub Pull Requests License


This is a car rental project

πŸ“ Table of Contents

🧐 About

Lendors is a web app created for the purpose of helping people rent cars easily and sinplify the management of cars and car company assets

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

Node Version 14+

Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

git clone https://github.com/mugishap/lendors-backend.git

Next

cd backend/

And then

npm run start

πŸ”§ Running the tests

To run some tests test the swagger file on the route of /api-docs

🎈 Usage

Admin can log in (Make sure you create admin credentials in seeds)

Admin can add cars(car model, car image URL, price) in the system.

Admin can also update the car information or remove it from the system.

Admin can view car rental requests, approve them, or reject them.

Admin can view customers, or remove them from the database

Customers can register themselves (Custore id, Customer name, Customer phone number, Address, email, and password).

Customers can log in using their email and password.

Anyone can view all cars(No need to log in).

Customers can make car rental requests(Only when they have logged in).

When the admin accepts or rejects the rental request the customer should receive an email notification.

πŸš€ Deployment

This app was deployed on cyclic

⛏️ Built Using

✍️ Authors

πŸŽ‰ Acknowledgements

  • Hat tip to anyone whose code was used
  • Inspiration
  • References

About

Backend for car renting site

https://lendors.vercel.app


Languages

Language:JavaScript 100.0%