Skip to content

"Ride-Royal API" is a RESTful web API that allows developers to easily integrate luxury car reservation services into their applications. The API provides endpoints for users to search for available cars, make reservations, and manage their bookings.

License

Notifications You must be signed in to change notification settings

michaelamponsah/ride-royale-api

Repository files navigation

Ride Royale Api

This project is designed for the reservation of fancy cars. If you are preparing for a special day or event and you want a cool car for it, this website is the best place for you. If you have a luxurious car and want to make some extra money from it, you can add it to our website and others will be able to reserve it!

Here are some of the benefits of using our website:

  • Wide selection of cars to choose from
  • Competitive prices
  • Easy and convenient booking process
  • 24/7 customer support

Main features of this website are:

  • Users can see details of all the cars.
  • Users can reserve a car for a special day (a car that hasn't been reserved yet).
  • Users can add their own cars and remove them if they want to.

Database Structure:

Project Documentation 📄

  • Front-end GitHub repository link👈

Kanban Board

Kanban Board link

Initial state of the Kanban Board:

image

Final state of the Kanban Board:

ride-royal-api-kanban

Team members: 3 (Bernabas yosef, Michael Amponsah, Saeqa Sultani)

Built With 🛠️

  • Programming Languages: Ruby, SQL.
  • Framework: Ruby on Rails.
  • Database: PostgreSQL.
  • Code Editor: VS Code.

Getting Started

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

Prerequisites

  • A web browser like Google Chrome.
  • A code editor like Visual Studio Code with Git and Ruby.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Ruby installation.

$ ruby --version && irb

To install rails, in the terminal kindly run this command:

$ gem install rails

Setup

Clone the repository using the GitHub link provided below.

Install

In the terminal, go to your file directory and run this command.

$ git clone https://github.com/michaelamponsah/ride-royale-api.git

Usage

Kindly modify the files as needed.

Run locally

Make your way to the correct directory by running this command:

$ cd ride-royale-api

Install the required dependencies to run the project with this command:

$ bundle install

Setup the database, run:

$ rails db:create
$ rails db:migrate
$ rails db:seed

Then run it in your browser with this command:

$ rails server

Run tests

To run tests, please run this command:

$ rspec

Authors

👤 Bernabas

👤 Michael Amponsah

👤 Saeqa

🚀 Future Features

  • We'd implement a robust Role Based Access Control feature.
  • We'd integrate a rating feature to allow users give ratings to cars booked.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

📝 License

This project is MIT licensed.

About

"Ride-Royal API" is a RESTful web API that allows developers to easily integrate luxury car reservation services into their applications. The API provides endpoints for users to search for available cars, make reservations, and manage their bookings.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published