Skip to content

SarvariHarshitha/Car-Rental-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Car Rental System API

Overview

The Car Rental System API allows users to manage car rentals, including booking, returning, and tracking cars. This API is designed to be a backend service for a car rental application, providing endpoints for CRUD operations on cars, customers, rentals, and more.

Features

  • Car Management: Add, update, delete, and list available cars.
  • Customer Management: Register new customers.
  • Authentication: Secure endpoints with user authentication.

Technologies Used

  • Backend Framework: Express.js
  • Database: PostgreSQL
  • Authentication: JWT (JSON Web Token)
  • Documentation: Postman

Installation

Prerequisites

  • Node.js
  • PostgreSQL
  • Git

Steps

  1. Clone the repository:

    git clone https://github.com/SarvariHarshitha/car-rental-api.git
    cd car-rental-api
  2. Install dependencies:

    npm install
  3. Configure environment variables:

    Create a .env file in the root directory and add the following:

    DATABASE_URL=your_database_url
    JWT_SECRET=your_secret_key
    
  4. Set up the database:

    npx prisma migrate dev
  5. Run the application:

    npm start

API Endpoints

Complete documentation is available at https://documenter.getpostman.com/view/38347414/2sAYBUDXXd

Contributing

Contributions are welcome! Please fork this repository and submit a pull request for any feature additions or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.


Feel free to customize this template based on your specific implementation and requirements.

Releases

No releases published

Packages

No packages published