This repository contains a Flutter application developed for AFS. The app is designed with a focus on cross-platform compatibility, ensuring a seamless experience on both Android and iOS. It follows modern Flutter development practices, leveraging state management, API integration, and a responsive UI.
- 📱 Cross-Platform: Runs smoothly on both Android and iOS.
- 🎨 Modern UI: Uses Flutter widgets for an interactive and user-friendly interface.
- 🔄 State Management: Efficiently manages app state using Provider (or any other state management technique used).
- 🌐 API Integration: Connects with RESTful APIs for fetching and updating data.
- 🛠 Flutter Best Practices: Uses clean architecture and well-structured code.
- 🌑 Dark Mode Support (if applicable).
- 📡 Offline Mode (if applicable).
- Flutter (Framework)
- Dart (Programming Language)
- Provider / Riverpod / Bloc (State Management, mention the one used)
- Firebase / Supabase / REST APIs (Backend Services, if used)
- Hive / Shared Preferences / SQLite (Local Storage, if used)
To run this app locally, follow these steps:
Make sure you have the following installed:
- Flutter SDK (>=3.10.5) → Download Flutter
- Dart SDK (>=3.0.0)
- Android Studio / Xcode (for running on Emulator/Simulator)
- VS Code (Recommended for Flutter Development)
git clone https://github.com/NoorEMobeen/flutter-app-afs.git
cd flutter-app-afs
### 3️⃣ Install Dependencies
Run the following command inside the project directory:
```sh
flutter pub get
To run the app on an emulator or a connected device:
flutter run
For a specific platform:
flutter run -d android
flutter run -d ios
flutter-app-afs/
│── lib/ # Main application code
│ ├── main.dart # Entry point of the app
│ ├── screens/ # Contains all screen widgets
│ ├── widgets/ # Reusable widgets/components
│ ├── services/ # API services and backend logic
│ ├── models/ # Data models
│ ├── providers/ # State management providers
│ ├── utils/ # Utility functions and helpers
│── assets/ # Images, icons, and static assets
│── pubspec.yaml # Flutter dependencies
│── README.md # Project documentation
If the app requires API keys, Firebase setup, or environment configurations, create a .env
or secrets.dart
file and add the necessary keys.
Example:
const String apiKey = "YOUR_API_KEY_HERE";
If you face issues while running the app:
- Run
flutter doctor
to check for missing dependencies. - Ensure all dependencies are installed with
flutter pub get
. - If an emulator is not running, start one via Android Studio or Xcode.
- Clear cache using:
flutter clean
flutter pub get
Contributions are welcome! If you'd like to contribute:
- Fork this repository.
- Clone it to your local machine.
- Create a new branch (
feature-branch
). - Commit your changes.
- Push the branch and create a Pull Request.
This project is licensed under the MIT License – see the LICENSE
file for details.
For any queries or discussions, feel free to reach out:
- Email: [email protected]
- GitHub: NoorEMobeen