https://github.com/progress2002/car-reservation-api
https://github.com/progress2002/car-reservation-api
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/progress2002/car-reservation-api
- Owner: Progress2002
- License: mit
- Created: 2023-07-13T16:16:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T17:30:05.000Z (almost 3 years ago)
- Last Synced: 2025-01-05T02:10:49.920Z (over 1 year ago)
- Language: Ruby
- Size: 115 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### Table of Contents
- [📖 carBooker](#car-booker)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Kanban Board ](#-kanban-board-)
- [React Frontend ](#-react-frontend-)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [📝 API documentation](#api-documentation)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
Cabooker (Backend) is a RESTful API for a car booking application. It allows users to book a car for a specific date and time. It also allows users to add and delete cars. The API is built with Ruby on Rails and uses Postgres as the database. It is consumed by its front-end counterpart [car-booker front-end](https://github.com/yodit93/car-reservation-front-end.git).
Backend
- Ruby on Rails
Database
- Postgresql
[ERD Diagram](https://lucid.app/lucidchart/3885e52f-ffbe-4394-a17c-22c1cd5f931a/edit?viewport_l[…]C909%2C0_0&invitationId=inv_7ce0f69f-1908-44d7-9875-841ddbc89414)
Api end points for users to:
- Sign up
- Sign in
- Sign out
- Add appointment for a Cars
- Delete appointment for a Cars
- Create and Delete Cars
Kanban Board - This project was built with a team of four.
- Kanban Board Link [Kanban Board](https://github.com/users/yodit93/projects/7/views/1)
- Initial state of the Kanban board [Kanban Board Screenshot](https://user-images.githubusercontent.com/53250640/253284640-fe30f83b-f7e1-4e34-ba79-e3127288e6dc.png)
React Frontend - CarBooker frontend [CarBooker frontend](https://github.com/yodit93/car-reservation-front-end.git)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Any web-browser.
- Latest version of Ruby on Rails
### Setup
Clone this [repo](https://github.com/Progress2002/car-reservation-api.git) to your desired folder.
```
git clone https://github.com/Progress2002/car-reservation-api.git
```
### Install
Run from a terminal
```
cd car-reservation-api
bundle install
```
### Database
**To connect the project to the database:-**
```
rails db:create
rails db:migrate
```
### Usage
**To run the project follow the following instruction:-**
```
rails s -p 3001
```
### Run tests (using rspec)
To run the models test
```
rspec ./spec/models
```
To run the API Doc and endpoint test
```
rails rswag:specs:swaggerize
```
### Deployment
You can deploy this project using: [render](https://render.com/).
## API Documentation
**Once connected to the database, you can check the full API Documentation in here (please, double check the port):**
```
http://127.0.0.1:3001/api-docs/index.html
```
👤 **Progress**
- GitHub: [@Progress2002](https://github.com/Progress2002)
- Twitter: [@Progress_2002](https://twitter.com/Progress_2002)
- LinkedIn: [@Progress](https://www.linkedin.com/in/progress-ezeamaka-27b114247)
👤 **Mugisha.I**
- GitHub: [@githubhandle](https://github.com/Tafloninno)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/mugisha-innocent-19b700238/)
👤 **Yodit Abebe**
- GitHub: [yodit93](https://github.com/yodit93)
- Twitter: [@yodtwit](https://twitter.com/yodtwit)
- LinkedIn: [Yodit Abebe](https://www.linkedin.com/in/yodit-abebe-ayalew/)
👤 **AdeJuwon DanieL Adesanya**
- GitHub: [@githubhandle](https://github.com/Ade179)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/adejuwon-adesanya-237b54239/)
- **Add Admin role**
- **Edit moto description**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Progress2002/car-reservation-api/issues).
If you like this project give us a ⭐️.
We would like to thank Microverse for this project and [Murat Korkmaz on Behance](https://www.behance.net/muratk) for the original design idea.
This project is [MIT](./LICENSE) licensed.