ResQLink is a Flutter-based mobile application designed for first responders to report incidents, request supplies, and manage emergency situations efficiently.
- Real-time Notifications
- Google Map Integration to the emergency location
- Incident Reporting
- Supply Requests
- Weather Information
- User Authentication
- Profile Management
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
- Flutter SDK: Ensure you have the Flutter SDK installed. For installation instructions, refer to the official Flutter documentation.
- IDE: An IDE like Android Studio, IntelliJ IDEA, or VS Code with the Flutter and Dart plugins.
- Firebase Account: This project uses Firebase for backend services like authentication and database. You will need a Firebase project.
-
Clone the repository:
git clone https://github.com/Pronoy513/ResQLink-Flutter.git cd ResQLink-Flutter -
Create the
.envfile: This project uses an.envfile to store API keys. This file is gitignored for security. Create a file named.envin the root directory of the project:c:\Users\prono\OneDrive\Desktop\ResQLink\ResQ Flutter\resqlink-mobile-app-project-idx\.envAdd your OpenWeatherMap API key to this file:
OPENWEATHER_API_KEY=your_actual_openweather_api_keyReplace
your_actual_openweather_api_keywith your valid API key. -
Firebase Setup: This project is configured to use Firebase. The necessary Firebase configuration file (
lib/firebase_options.dart) is included in the repository.- Add the Relevant API keys and application IDs in the
.envfile. - Ensure you have a Firebase project created at https://console.firebase.google.com/.
- The existing
firebase_options.dartis configured for the project IDresqlink-mobile-app. If you are using a different Firebase project, you will need to configure your app with Firebase. Follow the FlutterFire CLI documentation to add your Flutter app to your Firebase project and generate a newfirebase_options.dartfile. - For Android, ensure you have the
google-services.jsonfile from your Firebase project settings placed in theandroid/app/directory if it's not already configured viafirebase_options.dartor if you encounter issues. - For iOS, ensure you have the
GoogleService-Info.plistfile from your Firebase project settings placed in theios/Runner/directory if needed.
- Add the Relevant API keys and application IDs in the
-
Install dependencies: Navigate to the project directory in your terminal and run:
flutter pub get
-
Run the application: You can run the application on an emulator, simulator, or a physical device.
flutter run
To run on a specific device, use
flutter run -d <deviceId>. You can list available devices withflutter devices.
Key dependencies used in this project include:
firebase_corefirebase_authcloud_firestoreflutter_dotenvweatherlottiemaps_launcher
(Refer to the pubspec.yaml file for a full list of dependencies.)
Feel free to contribute and build with us!