This repository contains the source code for the Roommate Matching mobile application, developed using Flutter and Firebase. The app aims to connect individuals looking for roommates by matching profiles based on shared preferences and habits.
lib/main.dart: The entry point of the application, initializing the Firebase app and running the main app widget.lib/main/main_page.dart: Hosts the primary navigation, tab views and swappable cards.lib/UI/: Contains the user interface elements and screens for the app, surveys, and user profiles.lib/main/chat.dart: Implements the chat interface and functionality.lib/main/matches.dart: Contains the logic for matching user profiles.
cloud_firestore: Used for storing and retrieving user data and preferences.firebase_auth: Manages user authentication processes.firebase_database: Real-time database interactions for chat and user data handling.firebase_storage: Handles the uploading and storage of user profile images.
To run this project, ensure you have Flutter installed on your machine and a Firebase project set up with the necessary configurations.
- Clone the repository to your local machine.
- Navigate to the project directory and run
flutter pub getto install dependencies. - Open an emulator or connect a physical device.
- Execute
flutter runto build and run the app on your device.
Tests can be found in the test/ directory. Run tests using the flutter test command to ensure code quality and functionality.
This README is a brief overview of the app's structure and setup instructions. For more detailed information, please refer to the individual .dart files within the lib/ directory.
A few resources to get you started if this is your first Flutter project:
For help getting started with Flutter development, view the online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.