EddyShimwa / Rent-A-Ride-Back-End

Api built with Ruby on Rails for car rental management system. API allows to reserve a car, add a new car or delete an existing one.

Rent-A-Ride-Back-End

📗 Table of Contents

• 📗 Table of Contents
• 📖 Rent-A-Ride-Back-End
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Rent-A-Ride
    • API Documentation
    • Kanban board
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • ⚙️ UML DIAGRAM
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Rent-A-Ride-Back-End

Rent-A-Ride Backend is a Api built with Ruby on Rails for car rental management system. API allows to do a car rental, add a new car or delete an existing one.

🛠 Built With

Tech Stack

Rails API

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Create an API endpoint by rails.
• Fetch Available Cars
• Add Car
• Delete cars
• Favorite Car
• Delete Car

Rent-A-Ride

Click Here to access the frontend app that was built with react and redux toolkit

API Documentation

• API Documentation

Kanban board

• Link to Kanban Board

There are three collaborators in this team

• Kennedy Owusu
• EddyShimwa
• Pierre Celestin

(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:

• Install ruby
• Install Postgresql.

 gem install rails

Setup

Clone this repository to your desired folder:

  git clone https://github.com/EddyShimwa/Rent-A-Ride-Back-End.git
   cd Rent-A-Ride-Back-End

Install

Install this project with:

  gem install

Usage

To run the project, follow the next steps:

• Create database with the following command:

rails db:create

• Apply migrations with the following command:

rails db:migrate

• [Optional] Run the following command to fill the database with data:

rails db:seed

• Run the app by executing:

rails s --port=1800

Run tests

To run tests, run the following command:

rspec spec

⚙️ UML DIAGRAM

(back to top)

👥 Authors

👤 SHIMWA Pray Eddy

• GitHub: EddyShimwa
• Twitter: Eddy
• LinkedIn: Pray Eddy SHIMWA

👤 Kennedy Owusu

• GitHub: Kennedy Owusu
• Twitter: Eddy
• LinkedIn: Kennedy Owusu

👤 Pierre Celestin

• GitHub: Pierre Celestin
• Twitter: Pierre Celestin
• LinkedIn: Pierre Celestin

🔭 Future Features

• Add rating system
• Updating car details
• Add an admin to the database
• Better user interface

(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 star this repository

(back to top)

🙏 Acknowledgments

• I would like to thank all code reviewers and coding partners for making this project better.

• A big thank you to:

• https://www.behance.net/gallery/37706679/Circle-(Landing-page-Dashboard-Mobile-App)

• For such a beautiful UI design.

📝 License

This project is MIT licensed.

(back to top)