/wheel-wizard-api

Wheel Wizard API is a web application that allows users to book an appointment to take a car for a test ride.

Primary LanguageRubyMIT LicenseMIT

Wheel Wizard API

📗 Table of Contents

Wheel Wizard API

Wheel Wizard API is a web application that allows users to book an appointment to take a car for a test ride.

🛠 Built With

Tech Stack

Server

back to top

Kanban Board

This is a Link to our Kanban Board

This is the initial state of our Kanban boardimage (1)

ERD Diagram

image (2)

Live Demo

This is running live on render.

Key Features

  • User Sign_up and Sing_in
  • User can add cars with images
  • User can delete a car
  • User can make a car reservation

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

  • Ruby
  • Rails
  • Postgresql

Setup

Clone this repository to your desired folder:

  cd blog-app
  git clone https://github.com/Jaymelfah/wheel-wizard-api.git

Install

Install this project with:

  • After cloning type 'cd wheel-wizard'.
  • Run 'bundle install' to install all the required dependencies.

Usage

To run the project, execute the following command:

  • Run 'rails db:create' to create a new database
  • Run 'rails db:migrate' to migrate the db and build the schema
  • Run 'rails db:seed' to populate your database
  • Run 'rails s' to start the dev server

Read the documentation of the API

Tests

To run the tests, execute the following command

  • Run 'rspec spec' to run all the tests.

back to top

👥 Authors

👤 Jeremiah Melfah

👤 Ahmed Nazir Musah

👤 Kareem Magdy Wilson

👤 Evans Kupour

back to top

🔭 Future Features

Features to add to the project.

  • [ Add Option to Rent a Car ]

🤝 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...

back to top

Acknowledgments

We would like to thank Microverse and all our colleagures there.

❓ FAQ

  • Do I have to have any previous knowledge about ruby to use this project?

    • No!
  • How to use this project?

    • check the Getting Started section to have a complete guid on how to setup and run teh project.

back to top

📝 License

This project is MIT licensed.

back to top