HanningtoneM/carbook-api

The API of the carbook web application. Users can register, login, and browse the cars and book any car.

Carbook UI

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

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.

Project Documentation 📄

• API deployment link👈
• Front-End GitHub repository link👈

Kanban Board:

Kanban Board link

Database:

Initial state of the Kanban Board:

Team members: 4 (Hakim, Hanningtone,Ridwan, Amos)

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/teckim/carbook-api.git

Usage

Run locally

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

$ cd carbook-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

👤 Hakim BAHEDDI

• teckim

👤 Hanningtone Monda

• HanningtoneM

👤 Kinyera Amos

• bigmosi

👤 Mamadou Abdoulaye

• ridwanediallo

🤝 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

• Microverse
• Original design idea by Murat Korkmaz on Behance.
• FontAwesome and Flaticon for icons.

📝 License

This project is MIT licensed.