Tesla | Book a Ride App

---

📗 Table of Contents

• 📖 Tesla Booking Backend
  • 🛠 Built With
    • Key Features
    • Documentation
      • 🚀 Live Demo
      • Link to Frontend
  • 💻 Getting Started
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

About the project

📖 Tesla Booking Backend

Tesla Booking Backend is the rails only api app for the full stack tesla booking app. It provides all the endpoints for the frontend to consume. Here the logic for the app is implemented.

• Tesla Booking Frontend Kanban Board
• Tesla Booking Backend Kanban Board

Team Members

• Demes Abera Ameneshoa - GitHub: @demesameneshoa
• Fatema Nazari @78fatemanazari
• Arthur Emanuel G. Iturres @ITurres
• Mahammad Mostafa @mahammad-mostafa

ER Diagram

The API is designed as per the ER Diagram shown below which dictates the association of models and their relationships.

🛠 Built With

Tech Stack

• Ruby
• Rails
• PostgreSQL

Key Features

• Ruby on Rails As an API.
• Postgres Database.
• API Routed to Provide Response for Requests.
• Git Version Control.
• User Authentication Managed by Devise.
• JWT Token as Authorization Key.
• Models Associations.
• API Documentation.

(back to top)

API Documentation

• You can view the input json and response json formats and also you can interact with the API database to visualize the input and output flow of requests and responses.
• Api docs

Live Demo

• API URL

🎨 Link to Frontend

• Frontend

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

 mkdir tesla-booking-api
 cd tesla-booking-api

Setup

Clone this repository to your desired folder:

• With SSH:

  cd my-folder
  git clone git@github.com:mahammad-mostafa/tesla-booking-back-end.git

• With HTTPS:

  cd my-folder
  git clone https://github.com/mahammad-mostafa/tesla-booking-back-end.git

• With GitHub CLI:

  cd my-folder
  gh repo clone mahammad-mostafa/tesla-booking-back-end

Database setup

Connect to your local postgres database:

  Inside the config/database.yml file add your

  POSTGRES_USER=<username>
  POSTGRES_PASSWORD=<password>

Install

Install this project with:

  cd tesla-booking-back-end
  bundle install
  rails db:create - create the database
  rails db:migrate - run pending migrations for the current environment.
  rails db:seed

Usage

To run the project, execute the following command:

  rails server - Starts the development server
  rails console - Starts the interactive command line

(back to top)

Authors

👤 Demes Ameneshoa

• GitHub: @demesameneshoa
• Twitter: @demesabera
• LinkedIn: demesameneshoa

👤 Fatema Nazari

• GitHub: @78fatemanazari
• Twitter: @fati_nazari78
• LinkedIn: 78fatemanazari

(back to top)

🔭 Future Features

• Unit Tests
• Add More Endpoints
• Add Users Role Based Access

(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

We would like to acknowledge the Microverse community and the staff for their incredible support through out our journey.

• Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)

---