README.md

Tesla Car Booking Backend

Ivan Gonzalez & Bruno Kambere & Ali Baba & Hafiz Rasa & Steven Wafeek

📗 Table of Contents

• 📖 About the Project
  • 🔗 Link to Frontend React app
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 📑 Database ERD
    • Kanban borad
    • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Tesla Car Booking Backend

Tesla Car Booking Backend is the back-end app that provides a user api for booking Tesla cars test drives. This app is integrated with the front end React app linked below.

💻 Link to front end React app

The link to the React app:

• React app link

🛠 Built With

Tech Stack

Stack

• Ruby on Rails

Key Features

• Api endpoints
• Api endpoints documentation
• User Authorization && Authentication

(back to top)

📑 Database ERD

Kanban board

Our project utilizes a Kanban board to visualize and manage tasks throughout the development process. The board is divided into several columns representing different stages of the workflow. Each task is represented by a card that can be moved between columns as it progresses.

Columns:

• To Do: Tasks planned for the current or upcoming sprints.

• In Progress: Tasks that are actively being worked on.

• Review: Tasks that are completed and awaiting review.

• Done: Tasks that have been completed and implemented.

• Kanban board link

• Final Team Size: 5 members

• The initial state of Kanban board

(back to top)

🚀 Live Demo

The link to the project deployed:

• Live Demo api link

• Live Demo front end app link

(back to top)

💻 Getting Started

In this project we used RoR to build a Tesla Car booking api.

Prerequisites

In order to run this project you need:

1. Git.
2. Visual Studio Code or another code editor.
3. Browser.

Setup

To get a local copy, follow these steps.

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/hafiz1379/Tesla-car-booking-back-end.git

Install

This project does not require installation. Just clone the repository to your local machine. Even though, for general purposes, Install this project with:

  cd my-folder
  bundle install

Usage

To run the project, do the following:

1. Open your terminal
2. Navigate to your folder
3. Start the server (rails s)

   rails s

4. Open your browser at your local host

   http://localhost:3000

Run tests

To run tests, run the following command:

  cd project
  rspec spec

Create and set up the database

To run the backend app, run the following commands:

  cd project
  rails db:create
  rails db:migrate
  rails db:seed

(back to top)

👥 Authors

👤 Iván Gonzalez

• GitHub: @ivangonzalez224
• Twitter: @Ivan Gonzalez
• LinkedIn: Iván Gonzalez Robles

👤 Ali Baba Hussaini

• GitHub: @Alibaba2023
• LinkedIn Alibaba Hussaini

👤 Hafizullah Rasa

• GitHub: Hafiz Rasa
• LinkedIn: Hafiz Rasa

👤 Bruno Kambere

• GitHub: @kambereBr
• Twitter: @kambereBr
• LinkedIn: bruno kambere

👤 steven wafeek

• GitHub: StevenWafeek
• Twitter: steven_hakeem
• LinkedIn: steven wafeek

(back to top)

🔭 Future Features

• Delete a user api endpoint
• Delete a reservation api endpoint

(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 please leave a star!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse.

(back to top)

📝 License

This project is MIT licensed.

(back to top)