https://github.com/billymohajeri/final-group-capstone-backend
Cottage Booking is an app that helps users find cottages and reserve them. The app allows users to add new cottages, remove cottages, make reservations. Built with Ruby on Rails, React, Redux, and PostgreSQL.
https://github.com/billymohajeri/final-group-capstone-backend
postgresql ruby-on-rails
Last synced: 4 months ago
JSON representation
Cottage Booking is an app that helps users find cottages and reserve them. The app allows users to add new cottages, remove cottages, make reservations. Built with Ruby on Rails, React, Redux, and PostgreSQL.
- Host: GitHub
- URL: https://github.com/billymohajeri/final-group-capstone-backend
- Owner: billymohajeri
- Created: 2023-05-11T07:45:50.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-29T07:27:43.000Z (about 3 years ago)
- Last Synced: 2025-06-13T04:07:42.203Z (about 1 year ago)
- Topics: postgresql, ruby-on-rails
- Language: Ruby
- Homepage: https://final-group-capstone-frontend-git-deploy-billymohajeri.vercel.app/
- Size: 95.7 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE/MIT.md
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Create database](#create-database)
- [👥 Authors](#authors)
- [📊 Kanban Board ](#kanban)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**Cottage booking app** is a booking app that allows users to search a list of available cottages and make reservations. This is the backend repository.
Frontend repo is [here](https://github.com/billymohajeri/Final-Group-Capstone-Frontend)
After launching a local server, this link provides access to API documentation: http://localhost:3000/api-docs/index.html
Client
Bundle
Server
Database
- **Create new user**
- **Create new cottage**
- **Delete cottage**
- **Add reservation**
- **Display my reservations list**
[Live Demo](https://final-group-capstone-frontend-git-deploy-billymohajeri.vercel.app/)
To get a local copy up and running, follow these steps:
### Prerequisites
In order to run this project you need:
- [Ruby on Rails](https://rubyonrails.org/) installed and running. To get more information, read the [installation guide](https://guides.rubyonrails.org/).
- [PostgreSQL](https://www.postgresql.org/) installed and running.
### Setup
Clone this repository to your desired folder:
Clone the back-end repo
```
git clone git@github.com:billymohajeri/Final-Group-Capstone-Backend.git
```
Clone the front-end repo
```
git clone git@github.com:billymohajeri/Final-Group-Capstone-Frontend.git
```
### Install
Install the backend project with:
```cd Final-Group-Capstone-Backend```
```bundle install``` to install all gems used.
```rails db:create``` to create the database.
```rails db:migrate``` to run the database migrations you created.
```rails db:seed``` to add a new uer to the database.
`rails s` to run the dev server.
Go to http://localhost:3000/api-docs/index.html to see API documentation.
Install the frontend project with:
```cd Final-Group-Capstone-Backend```
```npm install``` to install the app.
```npm start``` ro run the app.
👤 **Billy Mohajeri**
- GitHub: [@BillyMohajeri](https://github.com/billymohajeri)
- Twitter: [@BillyMohajeri](https://twitter.com/BillyMohajeri)
- LinkedIn: [@BillyMohajeri](https://www.linkedin.com/in/billymohajeri)
👤 **Gaurav Gangwar**
- GitHub: [@gauravgangwarweb](https://github.com/gauravgangwarweb)
- Twitter: [@gauravgangwar501](https://twitter.com/gauravgangwar501)
- LinkedIn: [Gaurav Gangwar](https://www.linkedin.com/in/gauravgangwarweb/)
👤 **Botlhale Setou**
- GitHub: [@Botlhale-Setou](https://github.com/Botlhale-Setou)
- Twitter: [@Botlhale_Setou](https://twitter.com/BotlhaleSetou)
- LinkedIn: [@botlhalesetou](https://www.linkedin.com/in/botlhalesetou/)
- Link to Kanban Board: [Kanban](https://github.com/users/billymohajeri/projects/6/views/1)
- Initial state of Kanban board: [Kanban Image](https://user-images.githubusercontent.com/58295348/237707763-a4569c96-d090-4692-92d4-93f411c10427.png)
- We are a group of 3 persons.
- [ ] **Improve the application UI**
- [ ] **Add comment button**
- [ ] **Improve authentication system**
- [ ] **Authorization**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, please consider giving it a star.
- I would like to thank all code reviewers for making this project better.
- Original design idea by [Murat Korkmaz on Behance](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign).
📸 Photos:
- [Houses Cottages](https://stocksnap.io/photo/houses-cottages-7KUECPAQ80) at Free Stock Image by 👤 Arno Smit
- [Wishbone Cottage, Malvern Hills](https://www.countryliving.com/uk/travel-ideas/staycation-uk/g25857853/cottages-rent-uk/?slide=9) at Unique Home Stays by 👤 Mark Watts
This project is [MIT](./LICENSE/MIT.md) licensed.