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.
MIT License
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.
To visit the frontend repository, please click here.
Main functionalities which the app will have:
Sorry, Currently no active link available.
To get a local copy up and running follow these simple example steps.
you have to those tools in your local machine.
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
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.
For installing necessary packages, run the following bash command:
bundle install
For setup database locally, run the following bash commands:
rails db:create
rails db:migrate
rails db:seed
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
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/**/*"
Shahadat Hossain
Sandro Hernandez
Sandro Hernandez
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.
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a if you like this project!
Can I use this project for personal use?
This project is MIT licensed.