Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hafiz1379/tesla-car-booking-back-end

Experience streamlined car management and reservations with our React and Rails web app, allowing admins to effortlessly handle inventory while users reserve cars by model, city, and time.
https://github.com/hafiz1379/tesla-car-booking-back-end

postgresql rails

Last synced: 4 days ago
JSON representation

Experience streamlined car management and reservations with our React and Rails web app, allowing admins to effortlessly handle inventory while users reserve cars by model, city, and time.

Awesome Lists containing this project

README

        

Tesla Car Booking Backend


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

# ๐Ÿ“— Table of Contents

- [๐Ÿ“– About the Project](#about-project)
- [๐Ÿ”— Link to Frontend React app](#link-frontend)
- [๐Ÿ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [๐Ÿ“‘ Database ERD](#erd)
- [Kanban borad](#kanban-baord)
- [๐Ÿš€ Live Demo](#live-demo)
- [๐Ÿ’ป Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [๐Ÿ‘ฅ Authors](#authors)
- [๐Ÿ”ญ Future Features](#future-features)
- [๐Ÿค Contributing](#contributing)
- [โญ๏ธ Show your support](#support)
- [๐Ÿ™ Acknowledgements](#acknowledgements)
- [๐Ÿ“ License](#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](https://github.com/ivangonzalez224/Tesla-car-booking-front-end)

## ๐Ÿ›  Built With

### Tech Stack

Stack

### 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](https://github.com/users/ivangonzalez224/projects/9)

- 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](https://tesla-car-booking-q0hb.onrender.com)

- [Live Demo front end app link](https://tesla-car-booking-front.onrender.com)

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

```sh
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:

```sh
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)

```sh
rails s
```

4. Open your browser at your local host

```sh
http://localhost:3000
```

### Run tests

To run tests, run the following command:

```sh
cd project
rspec spec
```

### Create and set up the database

To run the backend app, run the following commands:

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

(back to top)

## ๐Ÿ‘ฅ Authors

๐Ÿ‘ค **Ivรกn Gonzalez**

- GitHub: [@ivangonzalez224](https://github.com/ivangonzalez224)
- Twitter: [@Ivan Gonzalez](https://twitter.com/ivang2204)
- LinkedIn: [Ivรกn Gonzalez Robles](https://www.linkedin.com/in/ivรกn-gonzalez-robles-957491275/)

๐Ÿ‘ค **Ali Baba Hussaini**

- GitHub: [@Alibaba2023](https://github.com/Alibaba2023/)
- LinkedIn [Alibaba Hussaini](https://www.linkedin.com/in/ali-baba-hussaini-630607267/)

๐Ÿ‘ค **Hafizullah Rasa**

- GitHub: [Hafiz Rasa](https://github.com/hafiz1379)
- LinkedIn: [Hafiz Rasa](https://www.linkedin.com/in/hafiz1379/)

๐Ÿ‘ค **Bruno Kambere**

- GitHub: [@kambereBr](https://github.com/kambereBr)
- Twitter: [@kambereBr](https://twitter.com/kambereBr)
- LinkedIn: [bruno kambere](https://www.linkedin.com/in/bruno-kambere-399447138/)

๐Ÿ‘ค **steven wafeek**

- GitHub: [StevenWafeek](https://github.com/StevenWafeek)
- Twitter: [steven_hakeem](https://twitter.com/steven_hakeem)
- LinkedIn: [steven wafeek](https://www.linkedin.com/in/steven-wafeek-b629341b6/)

(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](https://github.com/hafiz1379/Tesla-car-booking-back-end/issues).

(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](./LICENSE) licensed.

(back to top)