Zoom Car API

To view a live example, click here

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 📋

You'll need Git and Node.js (which comes with NPM) installed on your computer.\

[email protected] or higher
[email protected] or higher
[email protected] or higher

---

How To Use 🔧

# Clone this repository
$ git clone https://github.com/laraib-sidd/zoom_car_api.git

# Go into the repository
$ cd zoom_car_api

Then you can install the dependencies either using NPM or Yarn:

Using NPM:

# Install dependencies
$ npm install

# Start development server
$ npm run develop

Using Yarn:

# Install dependencies
$ yarn

# Start development server
$ yarn develop

NOTE: If your run into issues installing the dependencies with NPM, use this command:

# Install dependencies with all permissions
$ sudo npm install --unsafe-perm=true --allow-root

Once your server has started, you can access the api at http://localhost:3000/ .

---

Instructions:

Registering

Do a post request at https://localhost:3000/user/ with proper data to register a user.:

Login

Do a post request at https://localhost:3000/user/login with valid credentials

Profile

Do a post request at https://localhost:3000/user/me with valid credentials

Logout

Do a post request at https://localhost:3000/user/logout with valid credentials

View all cars

Do a post request at https://localhost:3000/user/car/all with valid credentials

View available cars

Do a post request at https://localhost:3000/user/car/available with valid credentials

Book A car

Do a post request at https://localhost:3000/user/car/book/:{id} with valid credentials

View A particular Car

Do a post request at https://localhost:3000/user/car/:{id} with valid credentials

Update Booking

Do a post request at https://localhost:3000/user/car/update/:{id} with valid credentials

Delete a Booking

Do a post request at https://localhost:3000/user/car/delete/:{id} with valid credentials

---

Authors

• Laraib Siddiqui - https://github.com/laraib-sidd

License 📄

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