-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
314 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,169 @@ | ||
# README | ||
<a name="readme-top"></a> | ||
|
||
This README would normally document whatever steps are necessary to get the | ||
application up and running. | ||
<div align="center"> | ||
|
||
Things you may want to cover: | ||
</div> | ||
|
||
* Ruby version | ||
|
||
* System dependencies | ||
# 📗 Table of Contents | ||
|
||
* Configuration | ||
- [📖 About the Project](#about-project) | ||
- [🛠 Built With](#built-with) | ||
- [Tech Stack](#tech-stack) | ||
- [Key Features](#key-features) | ||
- [💻 Getting Started](#getting-started) | ||
- [Setup](#setup) | ||
- [Prerequisites](#prerequisites) | ||
- [Install](#install) | ||
- [Usage](#usage) | ||
- [Run tests](#run-tests) | ||
- [Frontend Repository](#frontend-repository) | ||
- [ERD Image](#erd-image) | ||
- [API Documentation](#api-documentation) | ||
- [👥 Authors](#authors) | ||
- [🔭 Future Features](#future-features) | ||
- [🤝 Contributing](#contributing) | ||
- [⭐️ Show your support](#support) | ||
- [🙏 Acknowledgements](#acknowledgements) | ||
- [❓ FAQ (OPTIONAL)](#faq) | ||
- [📝 License](#license) | ||
|
||
* Database creation | ||
# 📖 vehicle booking app <a name="about-project"></a> | ||
|
||
* Database initialization | ||
**vehicle booking app** is a Booking app made connectively with Ruby in Rails and React for front-end [vehicle booking app](https://github.com/tan12082001/Vehicle-Booking-App-Backend.git) React frontend App in JSON format through an API endpoint. | ||
|
||
* How to run the test suite | ||
## 🛠 Built With <a name="built-with"></a> | ||
|
||
* Services (job queues, cache servers, search engines, etc.) | ||
### Tech Stack <a name="tech-stack"></a> | ||
<details> | ||
<summary>Client</summary> | ||
<ul> | ||
<li><a href="https://react.dev/">React</a></li> | ||
<li><a href="https://react-redux.js.org/">React-Redux</a></li> | ||
<li><a href="https://redux-toolkit.js.org/">Redux Toolkit</a></li> | ||
</ul> | ||
</details> | ||
|
||
* Deployment instructions | ||
<details> | ||
- <summary>Server</summary> | ||
<ul> | ||
<li><a href="https://guides.rubyonrails.org/">Ruby on Rails</a></li> | ||
<li><a href="https://www.postgresql.org/docs/">PostgreSQL</a></li> | ||
</ul> | ||
</details> | ||
|
||
* ... | ||
### Key Features <a name="key-features"></a> | ||
|
||
- Rails API backend | ||
- React Front-end | ||
- Redux Toolkit used to consume the backend api | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 💻 Getting Started <a name="getting-started"></a> | ||
|
||
To get a local copy up and running, follow these steps: | ||
|
||
### Prerequisites | ||
|
||
In order to run this project you need: | ||
- A text editor of your choice ([VS Code](https://code.visualstudio.com/download) works well). | ||
- [Ruby and Rails](https://gorails.com/setup/windows/10) | ||
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) | ||
|
||
### Setup | ||
|
||
Use the following URL to clone this project: | ||
|
||
https://github.com/tan12082001/Vehicle-Booking-App-Backend.git | ||
|
||
### Install | ||
Open the terminal in the root directory of the project and run the following command to install all dependencies. | ||
|
||
bundle install | ||
|
||
### Frontend Repository | ||
Reference the [Frontend Repository](https://github.com/tan12082001/Vehicle-Booking-App-Frontend.git) for the corresponding frontend. | ||
|
||
### ERD Image | ||
Add an ERD image to visualize the database schema. | ||
## follow the below link to access | ||
(https://drawsql.app/teams/wineshuga/diagrams/book-appointment) | ||
|
||
### API Documentation | ||
Reference the API documentation for details on how to interact with the API. | ||
|
||
### Usage | ||
To start the development server, run the following command then navigate to `localhost:3000` in your browser. | ||
|
||
rails s | ||
|
||
Open [http://localhost:3000](http://localhost:3000/api/random_greeting) to view it in your browser. | ||
|
||
|
||
### Run tests | ||
There are no tests to run. | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
|
||
## 👥 Authors <a name="authors"></a> | ||
|
||
|
||
👤 **Suleiman Gacheru** | ||
|
||
- GitHub: [@hetrox8](https://github.com/hetrox8) | ||
- Twitter: [@suleimangacheru](https://twitter.com/suleimangacheru) | ||
|
||
|
||
👤 **Tanmayi manku** | ||
|
||
- GitHub: [@tan12082001](https://github.com/tan12082001) | ||
|
||
|
||
👤 **Winnie uzochukwu** | ||
|
||
- GitHub: [@winnie](https://github.com/Wineshuga) | ||
|
||
👤 **Winnie uzochukwu** | ||
|
||
- GitHub: [@toyybi bolaji](https://github.com/Simpleshaikh1) | ||
|
||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
|
||
## 🔭 Future Features <a name="future-features"></a> | ||
|
||
- None planned | ||
|
||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 🤝 Contributing <a name="contributing"></a> | ||
|
||
Contributions, issues, and feature requests are welcome! | ||
|
||
Feel free to check the [issues page](../../issues/). | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## ⭐️ Show your support <a name="support"></a> | ||
|
||
|
||
If you like this project, please give it a star ⭐️ and share it with your friends. | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
|
||
## 🙏 Acknowledgments <a name="acknowledgements"></a> | ||
|
||
I would like to thank <a href="https://www.microverse.org/">Microverse</a> for providing the resources and guidelines that enabled me to complete this project. | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
|
||
|
||
## 📝 License <a name="license"></a> | ||
|
||
This project is [MIT](./LICENSE) licensed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
fAtn19uLyNhgX/ZDtLX9gOmxM3j7ftyeD5FGXTr5TurQX1rvjgBdnm0UHa7hQW9zKTgW/8u36rGIsHkv7FXQNdQ973rqx622S76o7TTuxZ1ihrhKKDBZhb9L4tIxMOHhLxGvuUf8ztIP2LkuF6s4KhJxf5yQop+zKbasaxcdTHwAzNmx1E6gxiaQiRGSDqIkMKHllGjmc3rNT44N7z9I+h9Zm+J+mgrIcKU8lZ+tGbVNkE9dJoGGrWLFDeuP54liacjmiZACmMEq1E9QA7pyvDaL60PD678SLktthGbVbgySU2xg+TawbHTt9mkr458+padCCi3CV5JAcdKfG2uH8XgDdzKiXKXuFIkPNfhFL8msOhe0R0FiHlchWOelXYgMNAAbfR7Oxv2Rez08OCWn8DJFdmFf--1bfvO5+kKjsedmRn--3ahtbfXpTxPynTpxpi2WXg== | ||
Ub4GwFY64RuGmN4tF3T5NYa41bAEZFrbj2pAVHLkK0ERfIr8/I5mUxuJ2xQKuF2JRL2spC1jOhWTKyTS+7KphFxc25b4CuYsaBm5mI2Q4WGq+RdYKBr1F5fISRWFuEKVw0uSTg3Iu7wLvU0kBsyvrb4lvV15Q4ZrRLH74GDeZFGZMwbilbVX1Pjxv08GO/hHUksjZahlouqiYNtdVQU5ddM/TKScWeBiBt6VVl3r4u5Mmu9K2cIABpmGTaWWS1t8C+G9Afx93+8E4en9c+Vefn0jl0iP38ab9UrnzD5sV9jds/xSg5I1m/txc/OozZCypJRnIgifnEvas1U7thoZIkqMxNgqgtJ3wWM99gZPHMQ5APnMrwKamctsE9wjSNg9a6s9aj33EMBx+g2WdUkL2fLWM9LK--RXyuCv1yyZ786dyc--t1D0aqw6YPSrnsMMF+/oRA== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
example_id | status | run_time | | ||
---------------------------------------------------- | ------ | --------------- | | ||
./spec/models/car_spec.rb[1:1:1] | passed | 0.00587 seconds | | ||
./spec/models/car_spec.rb[1:1:2] | passed | 0.14159 seconds | | ||
./spec/models/my_reservation_spec.rb[1:1:1] | passed | 0.00397 seconds | | ||
./spec/models/my_reservation_spec.rb[1:1:2] | passed | 0.0029 seconds | | ||
./spec/models/user_spec.rb[1:1:1] | passed | 0.00157 seconds | | ||
./spec/models/user_spec.rb[1:1:2] | passed | 0.002 seconds | | ||
./spec/requests/api/cars_spec.rb[1:1:1] | passed | 0.05168 seconds | | ||
./spec/requests/api/cars_spec.rb[1:2:1:1] | passed | 2.02 seconds | | ||
./spec/requests/api/cars_spec.rb[1:2:2:1] | passed | 1.78 seconds | | ||
./spec/requests/api/cars_spec.rb[1:3:1:1] | passed | 0.02911 seconds | | ||
./spec/requests/api/cars_spec.rb[1:3:2:1] | passed | 0.02891 seconds | | ||
./spec/requests/api/cars_spec.rb[1:4:1:1] | passed | 0.02337 seconds | | ||
./spec/requests/api/cars_spec.rb[1:4:2:1] | passed | 0.55206 seconds | | ||
./spec/requests/api/my_reservations_spec.rb[1:1:1] | passed | 0.02825 seconds | | ||
./spec/requests/api/my_reservations_spec.rb[1:2:1:1] | passed | 0.0311 seconds | | ||
./spec/requests/api/my_reservations_spec.rb[1:2:2:1] | passed | 0.05047 seconds | | ||
./spec/requests/api/registrations_spec.rb[1:1:1:1] | passed | 0.01067 seconds | | ||
./spec/requests/api/registrations_spec.rb[1:1:2:1] | passed | 0.10001 seconds | | ||
./spec/requests/api/sessions_spec.rb[1:1:1:1] | passed | 0.02346 seconds | | ||
./spec/requests/api/sessions_spec.rb[1:1:2:1] | passed | 0.01105 seconds | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
require 'rails_helper' | ||
|
||
RSpec.describe Car, type: :model do | ||
describe 'associations' do | ||
it { is_expected.to have_many(:my_reservations) } | ||
it { is_expected.to have_many(:users).through(:my_reservations) } | ||
end | ||
|
||
# Add tests for other validations here | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
require 'rails_helper' | ||
|
||
RSpec.describe MyReservation, type: :model do | ||
describe 'associations' do | ||
it { is_expected.to belong_to(:user) } | ||
it { is_expected.to belong_to(:car) } | ||
end | ||
|
||
# Add tests for other validations here | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
require 'rails_helper' | ||
|
||
RSpec.describe User, type: :model do | ||
describe 'associations' do | ||
it { is_expected.to have_many(:my_reservations) } | ||
it { is_expected.to have_many(:cars).through(:my_reservations) } | ||
end | ||
|
||
# Add tests for other validations here | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.