Table of Contents

• Table of Contents
• [Homely]
  • Kanban Board
    • Screenshot of of the initial state of the Kanban board
  • Built With
    • Tech Stack
    • Key Features
  • Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • Authors
  • Future Features
  • Contributing
  • Show your support
  • Acknowledgments
  • License

[Homely]

Homely is a web app build using Ruby on Rails back-end and React front-end. Homely-backend provides the backend APIs, and Hello React 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
• Mulugeta Belete
• Oshie
• Chukwuma Paul Mosanya

Kanban Board

Screenshot of of the initial state of the Kanban board

Built With

Tech Stack

Key Features

• [Allows users to add houses]
• [Allows users to book/reserve visits to houses they like]
• [Delete houses]
• [See reservations]

Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

  git clone https://github.com/belmeetmule/homely-backend.git

Install

Install this project with:

  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:

  rails server

Run tests

To run tests, run the following command:

  rspec spec

Authors

Akhror Valiev Mulugeta Belete Wahaj Ali Chukuwuma Mosanya

• GitHub: GitHub Profile
• LinkedIn: LinkedIn Profile
• GitHub: GitHub Profile
• LinkedIn: LinkedIn Profile
• GitHub: GitHub Profile
• LinkedIn: LinkedIn Profile
• GitHub: GitHub Profile
• LinkedIn: LinkedIn Profile

Future Features

• 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

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project, you can give star this repo.

Acknowledgments

We would like to thank microverse for supporting to do this project.

License

This project is MIT licensed.