LodgeMate

Table of contents

• Project Description
• Project Objectives
• Project Features
• Technologies Used
• Backend Developer Tasks
• Contribution Guide
• Meet Our Backend Developers

Project Description

Students of various higher institutions in Nigeria will agree that over the years, sourcing for accommodation for non-first and final year students who do not want to or are unable to get accommodation on campus has always been a nightmare. While some of the students don't have the liberty of staying in affordable accommodation within the school campus and have to outsource for the accommodation off-campus. Details about the project here: https://docs.google.com/document/d/1WNzoe1g9QKg_rVlbS2Kdb3A7LYKnQOwRAMDUM-07Km8/edit?usp=sharing

Project Objectives

The aim of this project is to create a layout through web technology that will enable Students to source an accommodation easily and get a list of suitable ones closest to them. The following are the objectives this would bring:

• Develop a user-friendly web app that provides students with suitable accommodation when they input their preferred location, price range, and type of accommodation they want.

• Be an escrow between students and landlords/house agents to avoid students from being defrauded by getting detailed information of house owners.

• To provide accommodation listing for house owners.

• Aggregate available information on decent off-campus accommodation within approximate distance around the institution.

• To reduce the number of homeless and squatting active students in schools reduce.

Project Features

• landlord/Agent dashboard.

• Chat function on the Home page and School profile page.

• Hostel filtering Using price range, state, institution, and address options.

• Authentication of landlord/Agent and Admin.

• List Hostel (landlord/Agent)

• Update hostel status (If is still available for rent or not)

• Manage Users

• Add and manage Institution

Technologies Used

The stacks used for the project backend include:

Stack	Usage
PHP 8.0.6	Programming language.
Laravel 8.40	General backend
MySql	Database.

Backend Developer Tasks

• Install LARAVEL 8.

• Implement Two guard authentication for (users and admins).

• database design and structure.

• Integrate Model and Controller for hostel, user, institution, and admin.

• configure all routes

• Test all the functionalities of the application.

• Troubleshoot and Debug the application.

Contribution Guide

1. Fork the repository
2. Clone and then open it up on your prefered code editor

git clone https://github.com/zuri-training/LodgeMate-be-pjt-11.git

3. Open terminal and set upsream branch:

git remote add upstream https://github.com/zuri-training/LodgeMate-be-pjt-11.git

4. Pull upstream to get the latest update from the original repo (https://github.com/zuri-training/LodgeMate-be-pjt-11.git)

git pull upstream main

5. Create a new branch for the task your are doing eg:

git checkout -b landing-page

6. After making changes, do

git add .

7. Commit your changes with a descriptive commit message

git commit -m "commit message"

8. To make sure there are no conflicts:

git pull upstream main

9. Push changes to your new branch:

git push origin your-current-branch-name

10. Create a pull request to the main branch

Meet Our Backend Developers

Zuri PJT-11 Backend Team- feel free to contact us!

Saad Saheed

• Email - janbaoda@gmail.com
• GitHub - https://github.com/Saad-Saheed

Ajiboye Toyin Theophilus

• Email - toy505050@yahoo.com
• GitHub - https://github.com/tonbot

obioma chijindu Ezekiel

• Email - ezekielobiomachi1@gmail.com
• GitHub - https://github.com/obikiel

Muritala Muideen Demola

• Email - demolaade61@gmail.com
• GitHub - https://github.com/Meeit1992

femi banji

• Email - myapplemusic0822@gmail.com
• GitHub - https://github.com/oluwafemi08