LeslieAine/house-haven-back

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Frontend
  • 🚀 Api documentation
  • 🚀 Kanban board
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 House Haven

House Haven contains the backend code for a House Rental App, which allows users to reserve a house, add new houses, and delete existing ones. The backend is built using Ruby On Rails and communicates with the front end of the app to provide a seamless user experience. The backend includes functionality for user authentication and authorization, allowing only authorized users to perform actions such as adding or deleting houses. It also includes a Postgresql database to store information about the houses available for rent, as well as information about user reservations.

🛠 Built With

Tech Stack

Language

• Rails
• Postgresql

Key Features

• See various houses
• Reserve houses
• Add houses
• Delete houses

(back to top)

Front End app

Click here to access the front-end app that was built with React

(back to top)

API Documentation

You can test our API endpoints from the below link.

• Link to API Docs

(back to top)

Kanban Board

• Link to board
• Our team consists of 3 members: @LeslieAine, @Zeph180, and @mertkantaroglu

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Install ruby on your computer or run it with docker.
• Install Postgrsql.

Setup

• First, clone this repository by using the command line :

git clone https://github.com/LeslieAine/house-rental-back-end

• Create a secret key base locally by:

1. Remove config/master.key and config/credentials.yml.enc if they exist.
2. Run in the terminal: EDITOR=code rails credentials:edit
3. Close the editor that opens.
4. This command will create a new master.key and credentials.yml.enc if they do not exist.

Install

Install this project with:

bundle install

Usage

To run the project, follow the next steps:

• Create database with the following command:

rails db:create

• Apply migrations with the following command:

rails db:migrate

• [Optional] Run the following command to fill the database with data:

rails db:seed

• Run the app by executing:

rails s 

(back to top)

Deployment

You can deploy this project on render:

• Follow the steps in this documentation to deploy a rails app.

(back to top)

👥 Authors

👤 Kigozi Joseph

• GitHub: zeph180
• Twitter: @richards_zeph
• LinkedIn: Kigozi Joseph Suubi

👤 Mert Kantaroglu

• GitHub: @mertkantaroglu
• Twitter: @aranelluinwe
• LinkedIn: mertkantaroglu

👤 Leslie Aine

• GitHub: @LeslieAine
• LinkedIn: LeslieAine

(back to top)

🔭 Future Features

• Add rating system
• Updating house details
• Filter users by their roles

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give us a "⭐️".

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for project inspiration.

(back to top)

📝 License

This project is MIT licensed.

(back to top)