Shafeea Teach is the management and supervision module of the Shafeea Academy platform. This mobile application is specifically designed for teachers and supervisors to manage Quranic memorization circles (Halqas), track student performance in real-time, and generate comprehensive educational reports.
- Circle Management: Create and manage learning circles, assign teachers, and distribute students.
- User Administration: Review registration requests, manage teacher and student profiles.
- Data Analytics: Access a high-level dashboard with live statistics on progress, attendance, and performance.
- Bulk Operations: Import and export data using CSV files for efficient management of large academies.
- Interactive Tracking: Use a specialized digital Mushaf to record memorization, review, and recitation progress.
- Detailed Evaluation: Log word-level mistakes (pronunciation, grammar, memorization) with precision.
- Student Performance: View individual student progress charts and historical data to tailor educational support.
- Offline Mode: Record student performance without an internet connection; data syncs automatically once online.
| Category | Technology |
|---|---|
| Framework | Flutter (Multi-platform) |
| State Management | BLoC / Cubit |
| Networking | Dio with RESTful APIs |
| Local Database | SQLite (sqflite) |
| Persistence | Secure Storage & Shared Preferences |
| DI & Service Locator | Injectable / GetIt |
lib/
├── config/ # DI, Localization, Themes, and App Config
├── core/ # Error handling, Network, and UseCases
├── features/ # Modular features
│ ├── app/ # Global setup and app entry
│ ├── auth/ # Login and Authentication
│ ├── daily_tracking/ # Interactive Mushaf and student monitoring
│ ├── home/ # Teacher/Supervisor Dashboards
│ └── settings/ # User preferences
├── routes/ # Navigation and Routing (GoRouter)
├── shared/ # Reusable UI components
└── main.dart # App entry point
- Flutter SDK (Latest Stable)
- Dart SDK
- Git
-
Clone the repository:
git clone https://github.com/your-username/shafeea_teach.git cd shafeea_teach -
Get dependencies:
flutter pub get
-
Run Code Generation:
dart run build_runner build --delete-conflicting-outputs
-
Launch the application:
flutter run
For a detailed technical breakdown, including functional and non-functional requirements, database schemas, and architectural constraints, please refer to the Requirements Sheet.md.
We welcome contributions to enhance the Shafeea platform.
- Fork the repo.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.
Emran Nasser - GitHub
Project Link: https://github.com/shafeea-platform/shafeea_teach
Empowering Quranic Education through Technology.