📗 Table of Contents

• 📗 Table of Contents
• 📖 Car Rentals API
  • API Documentation
  • Frontend
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Car Rentals API

Car Rentals API is a backend API for a car rental application. It allows users to create an account, login, and book a car for a specific period of time. It also allows users to view all available cars, and view a specific car. It also allows users to view all bookings made by a specific user.

API Documentation

Link to API Documentation

Frontend

The frontend was made with react and can be found here

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Deploy application API on render
• Update Api documentation with deployed url

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:didierganthier/rent-a-car-backend.git

Install

Install this project with:

  cd car-rental-api
  bundle install

Usage

To run the project, execute the following command:

  rails db:create

  rails db:migrate

  rails db:seed

  rails server

Run tests

To run tests, run the following command:

  rspec

Deployment

You can deploy this project using:

  git push heroku main

(back to top)

👥 Authors

👤 Didier Peran Ganthier

• GitHub: @didierganthier
• Twitter: @didierganthier_
• LinkedIn: Didier Peran Ganthierr

👤 Habeeb Musa Efiamotu

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Shedrack Sunday

• GitHub: @Shedraxk-Sunday
• Twitter: @DeleSundayS
• LinkedIn: Shedrack-Sunday

(back to top)

🔭 Future Features

• Integrate Admin action.
• Integrate super users.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project consider giving it a star ⭐️.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me the opportunity to work on this project.

• Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)