https://github.com/kurtpetrola/fmd
A dedicated location-based application designed to help individuals find suitable long-term accommodation and dormitories near Pangasinan.
https://github.com/kurtpetrola/fmd
dormitory-finder educational-project location-based
Last synced: 3 months ago
JSON representation
A dedicated location-based application designed to help individuals find suitable long-term accommodation and dormitories near Pangasinan.
- Host: GitHub
- URL: https://github.com/kurtpetrola/fmd
- Owner: kurtpetrola
- License: mit
- Created: 2024-08-08T14:05:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-31T18:04:18.000Z (3 months ago)
- Last Synced: 2026-03-31T19:19:19.089Z (3 months ago)
- Topics: dormitory-finder, educational-project, location-based
- Language: Dart
- Homepage:
- Size: 97.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🏠 Find My Dorm
> [!NOTE]
> This application is currently not production-ready. It is developed and maintained solely for **educational, portfolio, and demonstration purposes**. Please do not use it for real-world, critical accommodation searches or rely on the data for decision-making.
---
**Find My Dorm is a dedicated location-based application designed to help individuals find suitable long-term accommodation and dormitories near Pangasinan.** By simplifying the search process, the app provides a user-friendly platform for anyone—whether a student, professional, or long-term visitor—to explore, compare, and locate safe and comfortable lodging options based on their specific needs and location preferences in the area.
## ✨ Features
We aim to simplify your dormitory search with these core functionalities:
- **Dormitory Listings:** Browse a comprehensive list of dormitory options specifically located in and around the Pangasinan region.
- **Interactive Map View:** Visually explore all dormitories on an **interactive map**, allowing users to easily check their proximity to universities, transportation hubs, and other essential services.
- **Dynamic Routing:** Powered by OpenRouteService API, providing accurate route generation and path visualization between dormitories and nearby landmarks.
- **Smart Filtering & Sorting:** Quickly narrow down search results using **advanced filters** (e.g., gender-specific, location) to find the perfect match.
- **Favorites & Comparison:** Save preferred dormitories to a **Favorites List** for easy re-access and side-by-side comparison.
## 📥 Installation
You can download the latest **Android APK** file and install the application manually from the **[releases page](https://github.com/kurtpetrola/fmd/releases)**.
## 💻 Tech Stack
| Component | Technology | Purpose |
| :------------------- | :----------------------- | :----------------------------------------------------------------------------- |
| **Mobile Framework** | **Flutter** | Cross-platform UI development for iOS and Android. |
| **Database** | **SQLite** | Local, lightweight, and fast data persistence for dorm listings and user data. |
| **Security** | **`bcrypt`** | Used for secure one-way hashing of user passwords. |
| **Mapping** | **`flutter_map`** | Provides interactive map views and location tracking. |
| **Routing API** | **OpenRouteService API** | Enables dynamic route generation and location-based mapping features. |
| **State Management** | **`provider`** | Lightweight dependency injection and reactive state management for ViewModels. |
## 🏗️ Project Architecture
The project follows a **Clean Architecture** approach with **Feature-First (Slice)** organization, ensuring scalability, maintainability, and clear separation of concerns.
```text
lib/
├── core/ # Global utilities, constants, shared widgets, and local database implementation
└── features/ # Feature directories containing their specific domain, presentation, and widgets
├── auth/
├── dorms/
├── maps/
├── splash/
└── user_profile/
```
## 🔑 Demo Accounts
Use the following accounts to quickly explore the application's different user roles (User and Admin) without needing to register:
- **User Account**
- **Email:** `test@fmd.com`
- **Password:** `TestUser99!`
- **Admin Account**
- **Email:** `admin@fmd.com`
- **Password:** `AdminTest99!`
## 🛠 To Do & Future Enhancements
The following tasks are prioritized for future development:
- **Data Expansion:** Significantly **expand the dormitory database** to offer a wider variety of options.
- **Advanced Filtering:** Implement new filters based on **amenities** (Wi-Fi, laundry, parking), **price range**, and **real-time availability**.
- **Community Integration:** Integrate **user reviews and ratings** for dormitories to enhance trust and transparency.
- **Map Enhancements:** Upgrade the interactive map with **real-time location updates** and detailed neighborhood information.
## 📄 License
This project is licensed under the **MIT License** - see the **[LICENSE](https://github.com/kurtpetrola/fmd/blob/main/LICENSE)** file for details.