Enterprise Digital Ecosystem for Quranic Education Management
Shafeea is an advanced Learning Management System (LMS) specifically engineered for Quranic education circles (Halqas). The platform addresses the administrative challenges of traditional education by providing a centralized, scalable digital infrastructure.
By integrating distinct portals for Supervisors, Teachers, and Students, Shafeea facilitates real-time academic tracking, seamless communication, and data-driven decision-making within a secure environment.
- Role-Based Access Control (RBAC): comprehensive permission systems ensuring data integrity across Student, Teacher, Supervisor, and Administrator roles.
- Halqa Lifecycle Management: Full administrative control over the creation, scheduling, modification, and archiving of educational circles.
- Enrollment History: Persistent logging of student placements, transfers, and academic history.
- Performance Metrics: Detailed daily and monthly tracking of memorization, revision, and recitation quality.
- Reporting Engine: Generation of aggregated reports regarding attendance trends, circle efficiency, and individual student progress.
- Digital Integration: Seamless interface designed to support digital Quranic text interaction.
- Notification Service: Automated alerts for assignments, administrative approvals, and system-wide announcements.
- Approval Pipelines: Structured workflows for user registration and critical data modification requests.
The platform is constructed upon a modern, monolithic architecture designed for reliability and maintainability.
| Component | Specification | Purpose |
|---|---|---|
| Backend Framework | Laravel 12 | Provides robust API routing, ORM, and queue management. |
| Language | PHP 8.2+ | Utilizes strict typing and latest engine optimizations. |
| Frontend | React 19 + TypeScript + Tailwind CSS + Inertia.js | Modern component-based SPA integrated with Laravel backend. |
| Database | MySQL / PostgreSQL | Manages relational data with high integrity constraints. |
| Testing Suite | Pest | Delivers expressive syntax for unit and feature testing. |
| Web Server | Nginx / Apache | Handles HTTP requests and load balancing. |
Ensure the following are installed in the local development environment:
- PHP version 8.2 or higher
- Composer
- Node.js & NPM
-
Clone the Repository
git clone https://github.com/Emran025/shafeea-platform.git cd shafeea-platform -
Install Dependencies
composer install npm install
-
Environment Configuration
cp .env.example .env php artisan key:generate
Note: Update the
.envfile with the appropriate local database credentials. -
Database Migration & Seeding To set up the schema and populate initial data:
php artisan migrate --seed
To reset the database entirely:
php artisan migrate:fresh --seed
-
Application Launch
npm build run php artisan serve
Or
npm run deploy
Or
npm run ds
The application will be accessible at
http://localhost:8000.
Contributions are essential to the open-source community. To contribute to the Shafeea Platform:
- Review the Contributing Guidelines in
CONTRIBUTING.md. - Fork the repository.
- Create a feature branch (
git checkout -b feature/NewFeature). - Commit changes (
git commit -m 'Add NewFeature'). - Push to the branch (
git push origin feature/NewFeature). - Open a Pull Request.
This project is licensed under the MIT License. Please refer to the LICENSE file for full terms and conditions.
Emran Nasser - Lead Developer
Email: amrannaser3@gmail.com
Project Repository: https://github.com/Emran025/shafeea-platform