Skip to content

Repository files navigation

🎓 Shafeea Student (أكاديمية شفيع)

Flutter Dart License: MIT

Shafeea Student is the official mobile application for Shafeea Academy, a comprehensive educational platform designed to empower students in their learning journey. Built with Flutter, the app provides a seamless, high-performance experience for tracking academic progress, accessing religious resources (including a full Quran reader), and managing daily educational activities.


🚀 Key Features

  • 📱 User-Friendly Dashboard: A centralized hub for students to view their progress and upcoming tasks.
  • 📖 Integrated Quran Reader: High-quality digital Quran with custom fonts and specialized reading modes.
  • 📊 Daily Tracking: Detailed logging and visualization of daily academic and spiritual activities.
  • 🌓 Dynamic Theming: Full support for light and dark modes with a premium aesthetic.
  • 🌍 Localization: Optimized for Arabic-speaking users with full RTL (Right-to-Left) support.
  • 🔒 Secure Authentication: Robust login system with device-aware security.

🛠️ Technology Stack

Category Technology
Framework Flutter
State Management BLoC / Cubit
Navigation GoRouter
Dependency Injection Injectable / GetIt
Networking Dio
Database SQLite (sqflite)
Charts FL Chart

📂 Project Structure

lib/
├── config/             # App configuration (DI, Routes, Themes, L10n)
├── core/               # Shared core logic (Network, Errors, UseCases)
├── features/           # Feature-based modules
│   ├── app/            # App-wide logic and setup
│   ├── auth/           # Authentication and User Management
│   ├── daily_tracking/ # Progress and activity tracking
│   ├── home/           # Main dashboard and core features
│   └── settings/       # User preferences and app settings
├── routes/             # Navigation routing definitions
├── shared/             # Reusable UI components and widgets
└── main.dart           # App entry point

🏁 Getting Started

Prerequisites

  • Flutter SDK (latest stable version)
  • Dart SDK
  • Android Studio / VS Code with Flutter extensions

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/shafeea_student.git
    cd shafeea_student
  2. Install dependencies:

    flutter pub get
  3. Generate code (Injectable & BloC):

    dart run build_runner build --delete-conflicting-outputs
  4. Run the app:

    flutter run

⚙️ Configuration

The app uses JSON configuration files for different environments:

  • config_dev.json: Development environment settings.
  • config_prod.json: Production environment settings (API URL, etc.).

Ensure these files are present in the root directory before building for production.


🤝 Contribution

Contributions are welcome! Please follow these steps:

  1. Fork the Project.
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
  3. Commit your Changes (git commit -m 'Add some AmazingFeature').
  4. Push to the Branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

📄 License

Distributed under the MIT License. See LICENSE for more information.


📬 Contact

Emran Nasser - GitHub

Project Link: https://github.com/shafeea-platform/shafeea_student


Created with ❤️ by the Shafeea Development Team

About

The Shafeea Student app is a mobile application built with Flutter, serving as the student portal for the Shafeea educational platform. It provides students with a seamless, intuitive interface to access courses, track learning progress, and manage their academic journey efficiently from any mobile device.

Topics

Resources

Stars

Watchers

Forks

Releases

Contributors

Languages