Carhub API

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • Kanban Board
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Carhub App

Carhub App: is a full stack web application with a react client and rails api that allows users to book reservations for renting or buying a car.

=> Link to the front-end main react app

🛠 Built With

Tech Stack

Client

• ReactJS

• Tailwind CSS

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• The user logs in to the website, only by typing the username
• The user can see links to: Cars, Reserve, My Reservations, Add Car, and Delete Car
• See a list of cars
• User can select the item and see details of the item
• user clicks the "Add item" link in the navigation panel they can see a form for adding a new item.
• When the user clicks the "Delete item" link in the navigation panel they can see a list of all items with title and "Delete" button.
• When the user clicks the "My reservations" link in the navigation panel they can see a list of their reservations (with information about item name, date and city).
• "Add item" and "Delete item" links are accessible only by users who are admins.

(back to top)

🚀 Live Demo

• Carhub App Live
• Backend API

(back to top)

🚀 Kanban Board

A Team of 5 Members worked on this project - See list of authors

• Kanban Board Link
• Kanban Screenshot 1
• Kanban Screenshot 2
• Kanban Screenshot 3

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

• React
• Redux
• Ruby
• Rails
• Code editor (VSCode, RubyMine)

Setup

Clone this repository to your desired folder:

  git clone https://github.com/unorjikingsley/Reservation-API.git

Install

Install this project run these commands in order:

  cd my-project
  bundle install
  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec ./spec/models

To run tests for controllers(request) and for API Documentation, run the following command:

Install the gem - Add the gem 'rswag' and gem 'rswag-ui' in your gem file and run bundle install

Run

  rails generate rswag:install

  rake rswag:specs:swaggerize

Deployment

You can deploy this project using your own deployment solution

(back to top)

👥 Authors

👤 Unorji Kingsley

• GitHub: @unorjikingsley
• LinkedIn: unorjikingsley

👤 Biftu Girma

• GitHub: @Bifabig
• Twitter: @biftu94
• LinkedIn: Biftu Girma

👤 Musangamfura Emmmanuel

• GitHub
• Twitter
• LinkedIn

👤 Salma Ibrahim

• GitHub: @Saluumaa
• Twitter: @SalmaHIbrahim20
• LinkedIn: Salma ibrahim

👤 Denio Nhanale

• GitHub: @Denio Nhanale
• Twitter: @Denio Nhanale
• LinkedIn: Denio Nhanale

(back to top)

🔭 Future Features

• Add an option to buy new cars
• Implement Edit button in the Delete car section
• Redirect the email confirmation link to the login page

(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 adding a ⭐️

(back to top)

🙏 Acknowledgments

Original design idea by Murat Korkmaz on Behance.

We would like to thank Microverse.

(back to top)

📝 License

This project is MIT licensed.

(back to top)