iRent app

Api Documentation

You can review the documentation for the API here.

This is the frontend repository

Description

A Web application that allows users to signin and make reservations for a house of their choice

Built With

Major languages: Ruby, HTML, Javascript, Bootstrap 5.
Frameworks: Ruby on Rails, React & Redux Toolkit.
Tools & Methods: RSpec, PostgreSQL, JWT, Jest, Css, Linters.

Getting Started

If you have Rails 7 installed, you can skip to the Setup section

Clone Repo

First clone this repo by running this command in your terminal:

git clone https://github.com/danielufeli/irentapp-final-capstone
# wait a couple seconds for it to download
# ...
# ...
# then move into the new directory
cd irentapp-final-capstone

Prerequisites

The following technologies must be installed before hand in your local machine:

Ruby (ruby --version). Should be 3.0.1 or newer.
Postgres ('pg', '~> 1.1')
Node.js (node --version)

The commands in parenthesis () can be used to verify if they are installed and their corresponding versions.

Refer to Section 3 from the official Rails Guide for more detailed instructions on how to install these technologies.

Install Rails

Once that's done, we can install Rails. For that, run these commands in your terminal:

gem install rails
# wait a few seconds for it to download
# ...
# ...
# verify that it was installed by running
rails --version

Live Demo 🌐

iRent Link

Setup

We're getting there... trust me ;)

Create the master key Open the config folder and create a file named: master.key Once it's created copy and paste the following key in it 8a994df6cf8c92ebbcf62224d96253ae Do not press space or enter after pasting the key, just save.

System Dependencies

Execute this command to automatically install all the dependencies needed to view and work on this project:

bundle install

The full list of dependencies can be found within the Gemfile.

This also installs PostgreSQL, which you'll need for the next step.

Database Initialization

To initialize the database we just created, now run:

rails db:setup

or if you experienced issues, run the following sequence

rails db:create
rails db:migrate
rails db:seed

Usage

If you got to this point, congratulations! You now have spent 2 hours in order to toy with my app. I appreciate your effort :P

Start Server

The following command should start a server

rails server

Which you can visit by going to http://localhost:3000 in your browser.

Testing RSpec

RSpec tests belong in another folder, which is /spec, all thanks to the ruby magic called naming conventions. Anyway, to run tests located in the spec folder run:

bundle exec rspec spec

How To Contribute?

Always remember to commit your contributions on a different branch. You can create a new one by running git checkout -b <branchname>.

Visit linters folder to learn how to setup linters.

Then check linters locally before pushing by running:

npx stylelint "**/*.{css,scss}"
# ...
# ...
rubocop --color -A

Finally, once your changes have no linter errors and all tests are passing, try to merge your branch into development by running:

git checkout development
git merge <branchname>

Continue by solving any merge conflicts that may arise, test the functionality of the app once more, and you're changes are ready to be pushed with git push origin <branchname>

That's all folks!

Kanban board

Here is the Kanban board of the project!

Here is the issue that contains the images of the initial state of the Kanban board

Final number of team members: 5

Collaborators

👤 Jeff Kayombo

Platform	Badge
GitHub	@JEFFKAY16

👤 Daniel Ufeli

Platform	Badge
GitHub	@danielufeli

👤 David Lafontant

Platform	Badge
GitHub	@david-lafontant

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

Original design Vespa by Murat Korkmaz on Behance

The ideas and inspiration from this project are coming from this online school of software development:

Microverse

📝 License

This project is MIT licensed.

david-lafontant/irentapp