https://github.com/prangonghose/earthbnb-backend
This web application is built to enable users browser through different houses which they can reserve on choice basis. The users can add their own houses to let other users reserve that for extra income. Users can register an account to use the website with full access with a unique username.
https://github.com/prangonghose/earthbnb-backend
postgresql rails-api ruby ruby-on-rails
Last synced: about 1 year ago
JSON representation
This web application is built to enable users browser through different houses which they can reserve on choice basis. The users can add their own houses to let other users reserve that for extra income. Users can register an account to use the website with full access with a unique username.
- Host: GitHub
- URL: https://github.com/prangonghose/earthbnb-backend
- Owner: PrangonGhose
- License: mit
- Created: 2023-05-04T15:41:36.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-07-28T17:25:27.000Z (almost 3 years ago)
- Last Synced: 2025-03-30T02:22:36.719Z (about 1 year ago)
- Topics: postgresql, rails-api, ruby, ruby-on-rails
- Language: Ruby
- Homepage: https://prangonghose.github.io/Earthbnb-frontend/
- Size: 111 KB
- Stars: 2
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Key Features](#key-features)
- [Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [📃 Kanban Board](#kanban-board)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
# 📖 Project Name
## EarthBnb Backend API
## About this project
This web application is built to enable users browser through different houses which they can reserve on choice basis. The users can add their own houses to let other users reserve that for extra income. Users can register an account to use the website with full access with a unique username. The whole application is built in two major parts. The [Earthbnb_backend](https://github.com/PrangonGhose/Earthbnb-backend) holds code for the API backend that returns and handles the database on API request from the frontend of this website. The database working behind the screen is a relational database developed with `PostgreSQL`. The [Earthbnb_frontend](https://github.com/PrangonGhose/Earthbnb-frontend) contains the user interface of the website where the users can interact with the database. The backend of the website is created with `Ruby on Rails API` and the frontend is created with `ReactJS` and `Redux`.
  
> Key features of the application.
- A full stack webapp where users can register and sign in using a unique username.
- Users can add, delete and browse through the reigstered houses and reserve any house on choice.
- API endpoints `/houses` and `/houses/:id` are available publicly whereas API endpoints `/reservations` and `/reservations/:username` is private only to registered and logged in users.
- Users will be able to reserve a house in an available date. It is made sure by the developers that a user cannot reserve a house within a date range if any other user has already reserved it.
- Users reservation data is private to every user and none can access each others data.
- The API returns different type of organized errors for bad requests.
- The UI of the website is built following this [design guidelines](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign).
- The API is documented using `rswag` [here](./swagger/v1/swagger.yaml).
- The databse tables are generated using this [ER diagram](./erdiagram.png).
Live demo is available [here](https://prangonghose.github.io/Earthbnb-frontend/).
**N.B: The backend API is not available due to the restriction on the free account on Render for hosting PostgreSQl databases. As a result new account registration and viewing of the inner UI is not available in the live demo. Take a look at the UI images below.**
## 💻 Getting Started
To clone the repository in local environment try following steps.
### Prerequisites
- [x] A code editor like Visual Studio Code with Git, Ruby, and Gem.
You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```
Likewise for `Ruby` and `gem` for package installation.
```
$ ruby --version && gem --version
```
**Note: This project is built with `Ruby` version 3.1.3**
### Setup
Clone the repository using [this link](https://github.com/PrangonGhose/Earthbnb_backend).
### Install
In the terminal, go to your file directory and run this command.
```
$ git clone https://github.com/PrangonGhose/Earthbnb_backend
```
### Get into development
In the terminal, run these commands to get into development.
```
$ cd Earthbnb_backend
$ bundle init
$ bundle install (install dependencies)
```
**Note: You might need to update [database.yml](./config/database.yml) for development and testing environments with necessary username and password for your database in their respective positions. Also make sure to comment out _pidfile_ and _workers_ at config/puma.rb to run the server without error.**
```
$ rails db:create
$ rails db:migrate
$ rails db:seed
This website is applicable for both mobile and desktop version.
### Run Test
```
$ rails db:create RAILS_ENV=test
$ rails db:migrate RAILS_ENV=test
$ rails rswag
```
The Kanban Board made for this project can be found [here](https://github.com/users/PrangonGhose/projects/2/views/2). The initial state of the Kanban Board can be found [here](https://user-images.githubusercontent.com/64170307/236311639-7e0ff546-f4e3-4308-ad24-4dc9de96e98c.png). There are four members in our team. Their details can be found in the [authors section](#authors).
👤 **Prangon Ghose**
- GitHub: [@PrangonGhose](https://github.com/PrangonGhose)
- LinkedIn: [Prangon Ghose](https://www.linkedin.com/in/prangon-ghose/)
👤 **Shinhyo Belliard**
- GitHub: [@ShinhyoBelok](https://github.com/ShinhyoBelok)
- Twitter: [@Bell_iraki](https://twitter.com/Bell_iraki)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/shinhyo-belliard-okazaki-807a38249/)
👤 **Glenda Diaz**
- GitHub: [@gjuliao](https://github.com/Gdiazdiaz)
- LinkedIn: [Glenda Diaz](www.linkedin.com/in/glendadiazz)
👤 **Victor Gonzalez**
- GitHub: [@Vgonma](https://github.com/Vgonma)
- LinkedIn: [Victor Gonzalez](https://www.linkedin.com/in/victor-manuel-gonzalez-massimi-a77265124/)
- [ ] **Add animation to create smooth user experience.**
- [ ] **Enable only admin users to add or delete houses.**
- [ ] **Implement proper user authentication from the front-end to the server.**
Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.
Feel free to check the [issues page](https://github.com/PrangonGhose/Earthbnb_backend/issues).
Give a ⭐️ if you like this project!
Authors would like to thank:
- [Murat Korkmaz](https://www.behance.net/muratk)
- [Microverse](https://www.microverse.org/)
- Code Reviewers
- Coding Partners
This project is [MIT](./LICENSE) licensed.