To run the Flutter mobile app locally, follow these steps:
-
Clone the GitHub repository:
git clone https://github.com/HaywhyD/ExpatSwapTask.git
-
Navigate to the project directory:
cd your-repository -
Install dependencies:
flutter pub get
-
Ensure you have a valid Firebase configuration file (google-services.json for Android, GoogleService-Info.plist for iOS) if you're using Firebase for authentication and Firestore for the database.
-
Connect a physical device or start an emulator.
-
Run the app:
flutter run
-
If you're using Google authentication:
- Follow the FlutterFire authentication documentation for setting up Google Sign-In: FlutterFire Authentication.
-
If you're using Facebook authentication:
- Follow the FlutterFire authentication documentation for setting up Facebook Sign-In: FlutterFire Authentication.
-
If you're using Firebase Firestore:
- Follow the FlutterFire Firestore documentation for setting up Firestore: FlutterFire Firestore.
-
If you're using SQLite:
- SQLite is a local database, so no specific setup is required. Ensure the necessary dependencies are added to the
pubspec.yamlfile. e.gsqflite: ^2.3.0
- SQLite is a local database, so no specific setup is required. Ensure the necessary dependencies are added to the
Include a brief README.md file in your GitHub repository:
# ExpatSwap Task
This Flutter mobile app allows users to input and submit personal information through a form, with authentication using Google or Facebook. The submitted data is stored in a database.
## Setup
1. **Clone the repository:**
```bash
git clone https://github.com/your-username/your-repository.git-
Navigate to the project directory:
cd your-repository -
Install dependencies:
flutter pub get
-
Authentication and Database Setup:
- Follow the instructions in the Authentication and Database Setup section.
-
Run the app:
flutter run
-
If using Google authentication, follow the FlutterFire Google Sign-In documentation.
-
If using Facebook authentication, follow the FlutterFire Facebook Sign-In documentation.
-
If using Firebase Firestore, follow the FlutterFire Firestore documentation.
-
If using SQLite, ensure the necessary dependencies are added to the
pubspec.yamlfile. e.gsqflite: ^2.3.0
- Users can edit or update their information.
- Implemented a feature to delete user data.
- List contributors or mention that the project is open for contributions.
This project is licensed under the MIT License.