From 79bbe782c387fb18449698aae344f972433ce10e Mon Sep 17 00:00:00 2001 From: Faranosh Amini Date: Sat, 4 Nov 2023 00:03:59 +0430 Subject: [PATCH 1/6] Update README.md --- README.md | 271 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 258 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7db80e4..1358634 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,269 @@ -# README +# Final group capstone - Book an Appointment For Renting Car -This README would normally document whatever steps are necessary to get the -application up and running. + -Things you may want to cover: +
+

ER Diagrma

+Screenshot 2023-09-25 at 12 07 22 -* Ruby version +
-* System dependencies +# πŸ“— Table of Contents -* Configuration +- [Final group capstone - Book an Appointment For Renting Car](#final-group-capstone---book-an-appointment-for-renting-car) +- [πŸ“— Table of Contents](#-table-of-contents) +- [πŸ“– Final group capstone - Book an Appointment ](#-final-group-capstone---book-an-appointment-) + - [πŸš€ Frontend App ](#-frontend-app-) + - [πŸ›  Built With ](#-built-with-) + - [Tech Stack ](#tech-stack-) + - [Key Features ](#key-features-) + - [πŸš€ Live Demo ](#-live-demo-) + - [πŸ’» Getting Started ](#-getting-started-) + - [Prerequisites](#prerequisites) + - [Install](#install) + - [Usage](#usage) + - [Run tests](#run-tests) + - [Run rails](#run-rails) + - [πŸ‘₯ Authors ](#-authors-) + - [πŸ“† Kanban Board ](#-kanban-board-) + - [πŸ”­ Future Features ](#-future-features-) + - [🀝 Contributing ](#-contributing-) + - [⭐️ Show your support ](#️-show-your-support-) + - [πŸ™ Acknowledgments ](#-acknowledgments-) + - [Development Team](#development-team) + - [Institution](#institution) + - [Reference Design](#reference-design) + - [πŸ“ License ](#-license-) -* Database creation + -* Database initialization +# πŸ“– Final group capstone - Book an Appointment -* How to run the test suite +**[Description]** -* Services (job queues, cache servers, search engines, etc.) +The project we built for the Final Project is based on an app to book an appointment for the best car in the world. -* Deployment instructions +## πŸš€ Frontend App +- [Click here to navigate to the Frontend ]() -* ... +

(back to top)

+ +## πŸ›  Built With + +### Tech Stack + +- Ruby on Rails >=7 +- React +- Postgres + +### Key Features + +- Connection between Ruby on Rails and React in different apps +- Book an appointment to try a car +- Cars that you selected as a theme +- Reserve form + +

(back to top)

+ + + +## πŸš€ Live Demo + +- [Live Demo Link](Live here...) + +

(back to top)

+ + + +## πŸ’» Getting Started + +### Prerequisites + +- [Ruby on Rails >=7](https://rubyonrails.org/) +- [React](https://reactjs.org/) +- [Postgres](https://www.postgresql.org/) +- [Git](https://git-scm.com/downloads) + +### Install + +``` +git clone https://github.com/hmunish/final-capstone-backend.git +cd final-capstone-backend +bundle install +``` +``` +git clone https://github.com/hmunish/final-capstone-frontend.git +cd final-capstone-frontend +npm install +``` + +### Usage + +In the project directory, run the first time: + + ``` + bundle exec rake assets:precompile + ``` + +then, you can use: + + ``` + ./bin/dev + ``` + +or: + + ``` + rails s + ``` + +Check on db/seed.rb for pre-loaded users, groups and, spendings, and likes for development + +### Run tests +In the project directory, run the first time: + + ``` + bundle exec rake assets:precompile + ``` +then, you can: + + ``` + rspec . + ``` +however, if you haven't run +``` +./bin/dev +``` + +### Run rails + +To configure the database connection in Rails, you need to update the database.yml file located in the config folder. Follow these steps: Locate the database.yml file in the config folder of your Rails application. + +1. Open the database.yml file using a text editor. + +2. Find the default: &default section in the file. + +3. Add the following lines under the default: &default section: +``` + host: localhost + username: your_username + password: your_password +``` + + +4. Replace your_username with your actual database username and your_password with your actual database password. +5. Save the changes to the database.yml file. +6. Run +``` +rails db:create +``` + +``` +rails db:migrate +``` + +``` +rails db:seed +``` + +``` +rails s +``` + + +

(back to top)

+ + + +## πŸ‘₯ Authors + +πŸ‘€ **Author name** + +- GitHub: []() +- LinkedIn: [LinkedIn]() + + +πŸ‘€ **Author name** + +- GitHub: []() +- LinkedIn: [LinkedIn]() + + +πŸ‘€ **Author name** + +- GitHub: []() +- LinkedIn: [LinkedIn]() + + +πŸ‘€ **Author name** + +- GitHub: []() +- Twitter: []() +- LinkedIn: [LinkedIn]() + +

(back to top)

+ + + +## πŸ“† Kanban Board + +- [Our kanban board](https://github.com/hmunish/final-capstone-backend/projects/1) +- [Kanban board initial state image]() +- We are a team of 4 members as stated in the authors section + +

(back to top)

+ +## πŸ”­ Future Features + +- Add different categories of Cars +- Add online shopping +- Add extra styling + +

(back to top)

+ + + +## 🀝 Contributing + +Contributions, issues, and feature requests are welcome! + +Check the [issues page](../../issues/). + +

(back to top)

+ + + +## ⭐️ Show your support + +If you found this project helpful, consider giving a ⭐️! + +

(back to top)

+ + + +## πŸ™ Acknowledgments + +We would like to express our deepest gratitude to all the people and institutions that have contributed to make this project possible. + +#### Development Team +- **Name 1**: +- **Name 2**: +- **Name 3**: +- **Name 4**: + +#### Institution +- **Microverse**: My sincerest thanks for creating this bootcamp. The program's structure and the quality of education provided have been crucial for my growth as a developer. + +#### Reference Design +- I would also like to thank [Murat Korkmaz] for the original design on Behance that served as inspiration for this project. + + +

(back to top)

+ + + +## πŸ“ License + +This project is [MIT](./LICENSE) licensed. + +

(back to top)

\ No newline at end of file From 3256b7368461ea0130001597396d2cd35b84c71e Mon Sep 17 00:00:00 2001 From: Faranosh Amini Date: Sat, 4 Nov 2023 00:05:58 +0430 Subject: [PATCH 2/6] Add the ER Diagram image --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1358634..192e976 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

ER Diagrma

-Screenshot 2023-09-25 at 12 07 22 +Screenshot 2023-09-25 at 12 07 22
@@ -177,7 +177,7 @@ rails s ## πŸ‘₯ Authors -πŸ‘€ **Author name** +πŸ‘€ **Abdourahmane Jalloh** - GitHub: []() - LinkedIn: [LinkedIn]() From ff08f57cdc3a200e98285081b7ed3e4695f30cb4 Mon Sep 17 00:00:00 2001 From: Faranosh Amini Date: Sat, 4 Nov 2023 00:16:30 +0430 Subject: [PATCH 3/6] Add the Authors Information --- README.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 192e976..2c55ac6 100644 --- a/README.md +++ b/README.md @@ -179,27 +179,26 @@ rails s πŸ‘€ **Abdourahmane Jalloh** -- GitHub: []() -- LinkedIn: [LinkedIn]() +- GitHub: [aradradev](https://github.com/aradradev) +- LinkedIn: [LinkedIn](https://www.linkedin.com/in/abdul-jalloh) -πŸ‘€ **Author name** +πŸ‘€ **Faranosh Amini** -- GitHub: []() -- LinkedIn: [LinkedIn]() +- GitHub: [FaranoshAmini](https://github.com/FaranoshAmini) +- LinkedIn: [LinkedIn](https://www.linkedin.com/in/faranosh-amini-9b925b23a/) -πŸ‘€ **Author name** +πŸ‘€ **Munish Halai** -- GitHub: []() -- LinkedIn: [LinkedIn]() +- GitHub: [hmunish](https://github.com/hmunish) +- LinkedIn: [LinkedIn](https://www.linkedin.com/in/munish-halai/) -πŸ‘€ **Author name** +πŸ‘€ **Sunga Thawethe** -- GitHub: []() -- Twitter: []() -- LinkedIn: [LinkedIn]() +- GitHub: [sunga12](https://github.com/sunga12) +- LinkedIn: [LinkedIn](https://www.linkedin.com/in/sungabanja-thawethe/)

(back to top)

@@ -246,10 +245,10 @@ If you found this project helpful, consider giving a ⭐️! We would like to express our deepest gratitude to all the people and institutions that have contributed to make this project possible. #### Development Team -- **Name 1**: -- **Name 2**: -- **Name 3**: -- **Name 4**: +- **Abdourahmane Jalloh**: +- **Faranosh Amini**: +- **Munish Halai3**: +- **Sunga Thawethe**: #### Institution - **Microverse**: My sincerest thanks for creating this bootcamp. The program's structure and the quality of education provided have been crucial for my growth as a developer. From 3a4741ceadfde549eb1b567919e581b35f1d8c67 Mon Sep 17 00:00:00 2001 From: Abdoul Date: Fri, 3 Nov 2023 20:48:21 +0000 Subject: [PATCH 4/6] adding thanks for the collanorators in this project --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2c55ac6..d8e0dca 100644 --- a/README.md +++ b/README.md @@ -245,10 +245,12 @@ If you found this project helpful, consider giving a ⭐️! We would like to express our deepest gratitude to all the people and institutions that have contributed to make this project possible. #### Development Team -- **Abdourahmane Jalloh**: -- **Faranosh Amini**: -- **Munish Halai3**: -- **Sunga Thawethe**: +- **Abdourahmane Jalloh**: Thank you for your dedication and hard work throughout this project. +- **Faranosh Amini**: Your expertise and commitment have been invaluable to the team. +- **Munish Halai3**: Your contributions have made a significant impact on our success. +- **Sunga Thawethe**: Your skills and teamwork have been much appreciated. + +Thank you, team, for your collaboration and effort! πŸ™ŒπŸΌπŸš€ #### Institution - **Microverse**: My sincerest thanks for creating this bootcamp. The program's structure and the quality of education provided have been crucial for my growth as a developer. @@ -263,6 +265,6 @@ We would like to express our deepest gratitude to all the people and institution ## πŸ“ License -This project is [MIT](./LICENSE) licensed. +This project is [MIT](../LICENSE) licensed.

(back to top)

\ No newline at end of file From 709423fc8e730bef7ad62c59033c57bc1247fe78 Mon Sep 17 00:00:00 2001 From: Abdoul Date: Fri, 3 Nov 2023 20:52:15 +0000 Subject: [PATCH 5/6] adding correct licence --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8e0dca..7379787 100644 --- a/README.md +++ b/README.md @@ -265,6 +265,6 @@ Thank you, team, for your collaboration and effort! πŸ™ŒπŸΌπŸš€ ## πŸ“ License -This project is [MIT](../LICENSE) licensed. +This project is [MIT](./LICENSE) licensed.

(back to top)

\ No newline at end of file From 65b2cb55f3605bff6c5cc9e0504076f4022fd8b9 Mon Sep 17 00:00:00 2001 From: Abdoul Date: Fri, 3 Nov 2023 21:20:19 +0000 Subject: [PATCH 6/6] making the request changes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7379787..0f58725 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ The project we built for the Final Project is based on an app to book an appointment for the best car in the world. ## πŸš€ Frontend App -- [Click here to navigate to the Frontend ]() +- [Click here to navigate to the Frontend ](https://github.com/hmunish/final-capstone-frontend)

(back to top)