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.
- 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.
Ensure you have the following installed on your machine:
- PHP (>=8.0)
- Composer
- Laravel Framework
- MySQL
- Node.js & npm
-
Clone the repository:
git clone https://github.com/obahchimaobi/RoomEase.git cd RoomEase -
Install dependencies:
composer install npm install
-
Set up the environment variables:
cp .env.example .env
Configure the database and mail settings in the
.envfile. -
Generate the app key:
php artisan key:generate
-
Run database migrations:
php artisan migrate
-
Serve the application:
php artisan serve
Access the application at http://127.0.0.1:8000
- Register/Login
- Browse available properties
- Save favorite listings
- Contact landlords
- Register/Login
- Add new property listings
- Manage property details
- View student inquiries
We welcome contributions! To contribute:
- Fork the repository.
- Create a new branch for your feature.
- Commit your changes.
- Submit a pull request.
If you encounter any issues, please report them via the GitHub Issues section.
RoomEase is open-source and available under the MIT License.
For inquiries and support, reach out via [email protected].