README.md

Rent Home Now API

📗 Table of Contents

• 📖 About the Project
  • 🛠 Frontend Repository
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 🧮 Kanban Board
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🔭 Acknowledgements
• ❓ FAQ
• 📝 License

🎯 Rent Home Now API

Rent Home Now API is the final capstone project for the Full Stack Developer Program at Microverse.

Rent Home Now API is RESTful API that facilitates the connection between property owners interested in renting out their properties and potential renters. The API allows for the creation of reservations on selected properties. It has been developed using the Ruby on Rails framework and uses a PostgreSQL database.

The app was built with a Ruby on Rails backend and a React/Redux frontend, located on separate repositories.

🛠 Frontend repository:

To visit the frontend repository, please click here.

🛠 Built With

Tech Stack

Technology

• Ruby
• Rails
• PostgresSQL

Tools

• VS Code
• GIT
• GITHUB

Key Features

Main functionalities which the app will have:

• User registration: Allow new users to register an account with the API by providing their personal information and creating a username and password.
• Property listing: Allow property owners to list their properties with the API by providing information such as property type, location, price, and availability.
• Reservation creation: Allow renters to create reservations for selected properties by providing the desired dates of the reservation and the number of occupants.
• Reservation management: Allow both property owners and renters to view, edit, and cancel existing reservations.
• API documentation: Provide comprehensive documentation for the API, including endpoints, parameters, responses, and error messages, to facilitate integration with external clients and applications.

(back to top)

🚀 Live Demo

Sorry, Currently no active link available.

(back to top)

🧮 Kanban Board

• Kanban Board link.
• Kanban Board initial state.
• Number of team members at start and finish: 3 Team members.

(back to top)

💻 Getting Started

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

Prerequisites

you have to those tools in your local machine.

• Ruby
• Rails
• PostgresSQL
• GIT & GITHUB
• Any Code Editor (VS Code, Brackets, etc)

Clone Repository

Clone the repository using the following bash command in an appropriate location.

  git clone [email protected]:shahadat3669/rent-home-now-api.git

Go to the project directory.

  cd rent-home-now-api

Adding credentials

Rails stores secrets in config/credentials.yml.enc, which is encrypted and hence cannot be edited directly. Rails uses config/master.key. If you have the master key, to add or change credentials in your terminal, run this command (change the name of you editor if you need for example code for VS Code)

  EDITOR="code" rails credentials:edit

This command will create the credentials file if it does not exist. Additionally, this command will create config/master.key if no master key is defined. Here pass the --wait flag to make sure the encryption happens after the edits have been saved and the editor closed.

  EDITOR="code --wait" rails credentials:edit

The scaffolded credentials.yml.enc looks like below:

  postgres_password: Database User Password
  smtp_user_name: SMTP User name
  smtp_password: SMTP User password

To learn more check Custom Credentials documentation.

Add necessary packages

For installing necessary packages, run the following bash command:

  bundle install

Setup Database locally

For setup database locally, run the following bash commands:

• Create a database in your local machine

  rails db:create

• Run necessary migrations

  rails db:migrate

• To insert seeds in the database, you can run:

  rails db:seed

Run the server in development mode

In the project directory, you can run the project by using following bash command:

  ./bin/dev

And now you can visit the site with the URL http://localhost:4000

Run the test

Before running the test command, please make sure you have run rails db:seed.

For testing you can run following bash command:

  bundle exec rspec --exclude-pattern "spec/requests/api/**/*"

(back to top)

👥 Authors

First Author:

Shahadat Hossain

Second Author:

Sandro Hernandez

Third Author:

Sandro Hernandez

(back to top)

🔭 Future Features

• Payment integration: Allow renters to pay for their reservations through the API using a secure payment gateway.

• Rating and review system: Allow renters to rate and review properties they have rented through the API, and allow property owners to view and respond to these reviews.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

👋 Show your support

Give a ⭐️ if you like this project!

(back to top)

🔭Acknowledgments

• My Family.
• Microverse

(back to top)

❓ FAQ

• Can I use this project for personal use?

  • Yes, you can use it.

(back to top)

📝 License

This project is MIT licensed.

(back to top)