Skip to content

Latest commit

 

History

History
136 lines (103 loc) · 5.53 KB

README.md

File metadata and controls

136 lines (103 loc) · 5.53 KB

Laravel Logo

📱 Contact & 👨 Social

🚀 Skills

💻 OS

RoomEase - Student Accommodation Made Easy

RoomEase is a web application that simplifies the process of finding and listing student accommodations. It provides a seamless connection between students and landlords with user-friendly features.

Features

  • Secure Authentication: Supports password-based and passwordless login.
  • Separate Portals: Dedicated portals for students and landlords.
  • Profile Management: Users can update their profiles with necessary details.
  • Property Listings: Landlords can list properties with descriptions and images.
  • Search & Filters: Students can search based on location, price, and amenities.
  • Favorites: Save properties for later viewing.
  • Notifications: Get notified of new listings and updates.

Installation

Prerequisites

Ensure you have the following installed on your machine:

  • PHP (>=8.0)
  • Composer
  • Laravel Framework
  • MySQL
  • Node.js & npm

Steps

  1. Clone the repository:

    git clone https://github.com/obahchimaobi/RoomEase.git
cd RoomEase

  2. Install dependencies:

    composer install
npm install

  3. Set up the environment variables:

    cp .env.example .env

    Configure the database and mail settings in the .env file.

  4. Generate the app key:

    php artisan key:generate

  5. Run database migrations:

    php artisan migrate

  6. Serve the application:

    php artisan serve

Access the application at http://127.0.0.1:8000

Usage

Student Portal

  • Register/Login
  • Browse available properties
  • Save favorite listings
  • Contact landlords

Landlord Portal

  • Register/Login
  • Add new property listings
  • Manage property details
  • View student inquiries

Contribution

We welcome contributions! To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature.
  3. Commit your changes.
  4. Submit a pull request.

Reporting Issues

If you encounter any issues, please report them via the GitHub Issues section.

License

RoomEase is open-source and available under the MIT License.

Contact

For inquiries and support, reach out via [email protected].