https://github.com/belmeetmule/homely-backend
Homely is a web app build using Ruby on Rails back-end and React front-end. Homely-backend provides the backend APIs for user registration, sign in, sign out, add house, list house, view house detail, book visit and view booked visits.
https://github.com/belmeetmule/homely-backend
devise jwt-authentication postgresql rspec-rails ruby-on-rails
Last synced: 4 months ago
JSON representation
Homely is a web app build using Ruby on Rails back-end and React front-end. Homely-backend provides the backend APIs for user registration, sign in, sign out, add house, list house, view house detail, book visit and view booked visits.
- Host: GitHub
- URL: https://github.com/belmeetmule/homely-backend
- Owner: belmeetmule
- Created: 2023-05-04T09:09:29.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-05-23T19:37:36.000Z (about 3 years ago)
- Last Synced: 2024-10-03T12:29:07.608Z (almost 2 years ago)
- Topics: devise, jwt-authentication, postgresql, rspec-rails, ruby-on-rails
- Language: Ruby
- Homepage: https://homelyheaven.netlify.app/
- Size: 648 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Homely
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Homely\] ](#-homely-)
- [Kanban Board](#kanban-board)
- [Screenshot of of the initial state of the Kanban board](#screenshot-of-of-the-initial-state-of-the-kanban-board)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**Homely** is a web app build using Ruby on Rails back-end and React front-end. [Homely-backend](https://github.com/belmeetmule/homely-backend) provides the backend APIs, and [Hello React Frontend](https://github.com/Wahaj-Ali/homely-frontend) consumes the APIs. The app allows user to see and book houses for onsite visits.
## Kanban Board
We are a team of 4 members.
- [Wahaj Ali](https://github.com/Wahaj-Ali)
- [Mulugeta Belete](https://github.com/belmeetmule)
- [Oshie](https://github.com/akhror-valiev)
- [Chukwuma Paul Mosanya](https://github.com/blase147)
[Kanban Board](https://github.com/belmeetmule/homely-backend/projects/1)
### Screenshot of of the initial state of the Kanban board
Server
Database
- **[Allows users to add houses]**
- **[Allows users to book/reserve visits to houses they like]**
- **[Delete houses]**
- **[See reservations]**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/belmeetmule/homely-backend.git
```
### Install
Install this project with:
```sh
cd homely-backend
bundle install
rails db:create
rails db:migrate
1. Remove config/master.key and config/credentials.yml.enc if they exist.
2. Run in the terminal: EDITOR=code rails credentials:edit , then close the editor that opens.
3. This command will create a new master.key and credentials.yml.enc if they do not exist.
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Run tests
To run tests, run the following command:
```sh
rspec spec
```
👤 **Akhror Valiev**
👤 **Mulugeta Belete**
👤 **Wahaj Ali**
👤 **Chukuwuma Mosanya**
- GitHub: [GitHub Profile](https://github.com/akhror-valiev)
- LinkedIn: [LinkedIn Profile](https://www.linkedin.com/in/oshie/)
- GitHub: [GitHub Profile](https://github.com/akhror-valiev)
- LinkedIn: [LinkedIn Profile](https://www.linkedin.com/in/oshie/)
- GitHub: [GitHub Profile](https://github.com/akhror-valiev)
- LinkedIn: [LinkedIn Profile](https://www.linkedin.com/in/oshie/)
- GitHub: [GitHub Profile](https://github.com/akhror-valiev)
- LinkedIn: [LinkedIn Profile](https://www.linkedin.com/in/oshie/)
- [ ] **Add admin role so that the admin see the booking in a given date and/or date range**
- [ ] **Use pagination in stead of sending all houses in sindle get request**
- [ ] **Search for houses**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Htetaungkyaw71/Blog-App/issues).
If you like this project, you can give star this repo.
We would like to thank microverse for supporting to do this project.
This project is [MIT](./MIT.md) licensed.