Skip to content

Laksopan23/EduInsight

BranchesTags

Repository files navigation

📚 EduInsight - School Management System

A comprehensive Laravel 10 school management system designed to manage students, teachers, guardians, exam schedules, results, fees, communications, and more.

✅ Project Status: PRODUCTION-READY

  • Framework: Laravel 10.10
  • PHP Required: 8.1+
  • Database: MySQL 5.7+
  • Status: Complete & Error-Free
  • Ready to Deploy: YES

🚀 Quick Start (5 Steps)

Prerequisites

Install these three tools first:

Setup

# 1. Create database
# Open MySQL and run: CREATE DATABASE db_school;

# 2. Install dependencies
composer install

# 3. Run migrations
php artisan migrate

# 4. Start server
php artisan serve

# 5. Open browser
# Visit: http://localhost:8000

Or use the automated script:

# Windows users - double-click:
setup.bat

# Then run:
start.bat

✨ Core Features

👥 User Management

  • 5 User Roles: Admin, Teacher, Student, Parent, Guardian
  • Authentication: Secure login/registration with Laravel UI
  • Profile Management: User profiles, avatars, password reset
  • Authorization: Role-based access control (RBAC)

📖 Academic Management

  • Student System: Complete student records with enrollment tracking
  • Teacher System: Teacher profiles with qualifications and experience
  • Guardian Portal: Parent/guardian access to student information
  • Subject Management: Course and subject management
  • Class Assignment: Grade and section management

📝 Exam & Results

  • Exam Scheduling: Create and manage exam schedules with dates/times
  • PDF Export: Generate and download exam schedules as PDFs
  • Results Tracking: Record and view student exam results by subject
  • Grade Management: Comprehensive grade tracking and reporting

📢 Communication

  • Announcements: Send messages to students, teachers, parents
  • Scheduled Messaging: Schedule announcements for future delivery
  • Meeting Integration: Include meeting links in communications
  • Recipient Management: Multi-recipient support with pivot tables

💰 Finance Management

  • Fee Tracking: Manage different fee types and student fees
  • Invoice Generation: Generate and download fee invoices
  • Payment Tracking: Track fee payment status

🤖 Advanced Features

  • AI Chatbot: OpenAI-powered student assistant (Sri Lankan curriculum)
  • Excel Support: Import/export students and data to Excel
  • Dynamic Menus: Hierarchical navigation menu management
  • Multiple Dashboards: Role-specific dashboards for each user type
  • PDF Generation: DomPDF integration for reports and schedules

🏗️ Architecture

Tech Stack

  • Framework: Laravel 10.10 (PHP 8.1+)
  • Database: MySQL 5.7+ with Eloquent ORM
  • API: RESTful API with Laravel Sanctum authentication
  • Frontend: Vite 4.0 asset pipeline, Blade templates
  • Authentication: Laravel UI + Custom RBAC
  • Additional: OpenAI API, DomPDF, Maatwebsite Excel, Yajra DataTables

Code Organization

app/
├── Http/
│   ├── Controllers/          (14 controllers)
│   ├── Middleware/           (Authentication, RBAC)
│   ├── Requests/             (Form validation)
│   └── Kernel.php
├── Models/                   (10 Eloquent models)
├── Providers/                (Service providers)
├── Rules/                    (Custom validation rules)
└── Exceptions/

database/
├── migrations/               (19 table migrations)
├── factories/                (Database factories for testing)
└── seeders/                  (Database seeders)

routes/
├── web.php                   (193 web routes)
├── api.php                   (RESTful API endpoints)
└── auth.php                  (Authentication routes)

resources/
├── views/                    (Blade templates)
├── css/                      (Stylesheets)
└── js/                       (JavaScript)

config/                       (Laravel configuration)
storage/                      (Logs, uploads, cache)
public/                       (Web root, assets)
tests/                        (Unit and feature tests)

🗄️ Database Schema

19 Database Tables

  • Users: User accounts with roles and profiles
  • Students: Student records with enrollment info
  • Teachers: Teacher profiles with qualifications
  • Subjects: Course/subject definitions
  • Exam Schedules: Exam dates, times, venues with PDF storage
  • Results: Student exam results by subject
  • Communications: Announcements and messages
  • Guardian_Student: Parent-student relationships
  • Communication_User: Message recipient tracking
  • Fees_Types: Fee category definitions
  • Fees_Information: Student fee records
  • Menus: Navigation menu hierarchy
  • User_Types: User type definitions
  • And 6 more supporting tables

Key Relationships

  • Users has many Students (one teacher can teach multiple classes)
  • Students belongsToMany Guardians (many parents per student)
  • Teachers has many Results (teachers grade students)
  • Communications belongsToMany Users (messages to multiple recipients)
  • Results belongsTo Student, Teacher, Subject

🔐 Security Features

Authentication & Authorization

  • ✅ CSRF protection on all forms
  • ✅ Secure password hashing (bcrypt)
  • ✅ Role-based authorization (Admin, Teacher, Student, Parent)
  • ✅ API authentication via Laravel Sanctum
  • ✅ Email verification ready

Data Protection

  • ✅ Input validation on all forms
  • ✅ SQL injection protection (Eloquent ORM)
  • ✅ XSS prevention (Blade escaping)
  • ✅ Environment variables for sensitive data
  • ✅ API rate limiting ready

Environment Security

  • ✅ .env file is git-ignored (not tracked in version control)
  • ✅ .env.example provided as template
  • ✅ APP_KEY pre-generated
  • ✅ Sensitive credentials removed from repository
  • ✅ Production configuration guidelines included

Important: Update your .env with:

  • Database password: DB_PASSWORD=your_password
  • OpenAI key (optional): OPENAI_API_KEY=sk-...
  • Zoom credentials (optional): ZOOM_CLIENT_ID=...

📊 Routes & Endpoints

Web Routes (193 total)

  • Dashboard: /home, teacher/student/parent dashboards
  • Users: /user/list, edit, delete, password change
  • Students: /student routes for full CRUD
  • Teachers: /teacher routes
  • Guardians: /guardian/list, add, edit, delete
  • Exams: /exam_schedule full management
  • Results: /results view, create, edit
  • Communications: Announcements and messaging
  • Accounts: Account management
  • Invoices: Fee invoice generation

API Endpoints

  • POST /api/chat - AI chatbot (student only)
  • GET /api/user - Get authenticated user (Sanctum)

🛠️ Available Commands

# Setup & Installation
composer install              # Install PHP dependencies
npm install                   # Install NPM dependencies
npm run build                 # Build frontend assets
php artisan migrate           # Run database migrations
php artisan migrate:rollback  # Rollback migrations

# Development
php artisan serve             # Start development server (http://localhost:8000)
php artisan tinker            # Interactive shell
php artisan cache:clear       # Clear all caches
php artisan config:clear      # Clear config cache

# Database
php artisan migrate:status    # Check migration status
php artisan db:seed           # Run database seeders
php artisan make:migration    # Create new migration

# Useful Utilities
php artisan route:list        # List all routes
php artisan make:controller   # Generate new controller
php artisan make:model        # Generate new model
php artisan optimize:clear    # Clear all optimizations

# Testing
php artisan test              # Run unit tests
vendor/bin/phpunit            # Run PHPUnit directly

📋 Configuration

Environment File (.env)

# Application
APP_NAME=EduInsight
APP_ENV=local
APP_DEBUG=true
APP_URL=http://localhost

# Database
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=db_school
DB_USERNAME=root
DB_PASSWORD=                    # Add your password

# Optional APIs
OPENAI_API_KEY=                 # Add for chatbot
ZOOM_CLIENT_ID=
ZOOM_CLIENT_SECRET=

Update credentials in .env for your environment.

🐛 Troubleshooting

Issue Cause Solution
"php not recognized" PHP not installed Install PHP 8.1+ and add to Windows PATH
"composer not found" Composer not in PATH Install from getcomposer.org
"Class not found" Dependencies missing Run composer install
"SQLSTATE[HY000]" Database connection error Check MySQL is running, db_school exists
"No migrations found" Database issue Run php artisan migrate
"Assets missing" Frontend not built Run npm install && npm run build
"Permission denied" File permissions Run PowerShell as Administrator
"Port 8000 already in use" Port conflict Use php artisan serve --port=8001

📦 Dependencies

PHP Packages

  • laravel/framework (10.10) - Core framework
  • laravel/ui (4.2) - Authentication scaffolding
  • laravel/sanctum (3.2) - API authentication
  • openai-php/client (0.10.3) - OpenAI API
  • barryvdh/laravel-dompdf (3.1) - PDF generation
  • maatwebsite/excel (3.1) - Excel handling
  • yajra/laravel-datatables (10.11) - Data tables
  • brian2694/laravel-toastr (5.57) - Notifications
  • And more...

NPM Packages

  • vite (4.0) - Asset bundler
  • axios (1.1.2) - HTTP client
  • laravel-vite-plugin - Vite integration

📈 Performance

  • Optimized Queries: Eager loading to prevent N+1 queries
  • Caching: File-based caching configured
  • Asset Pipeline: Vite for fast asset compilation
  • Database Indexes: Proper indexing on all tables
  • Rate Limiting: Ready for API rate limiting

🧪 Testing

The project includes PHPUnit configuration for testing:

php artisan test              # Run all tests
php artisan test --filter=TestName  # Run specific test

🚀 Deployment

Production Checklist

  • Set APP_ENV=production
  • Set APP_DEBUG=false
  • Generate APP_KEY (usually auto-generated)
  • Use strong database password
  • Configure real email service
  • Set up proper backups
  • Enable HTTPS/SSL
  • Review and secure all .env variables
  • Run php artisan config:cache
  • Run php artisan route:cache

📚 Documentation Links

📁 Project Files

Root Directory

  • artisan - Laravel CLI tool
  • composer.json - PHP dependencies
  • package.json - NPM dependencies
  • .env - Application configuration (local, git-ignored)
  • .env.example - Configuration template
  • .gitignore - Git ignore rules
  • phpunit.xml - Testing configuration
  • vite.config.js - Vite configuration
  • setup.bat - Automated setup script
  • setup.ps1 - PowerShell setup
  • start.bat - Server launcher

🤝 Contributing

  1. Clone the project
  2. Copy .env.example to .env
  3. Add your credentials
  4. Run composer install
  5. Run php artisan migrate
  6. Make changes
  7. Test with php artisan test
  8. Commit and push

✅ Project Completeness

Aspect Status Details
Code ✅ 100% All features implemented
Features ✅ Complete All modules functional
Database ✅ 19 tables Migrations ready
Tests ✅ Setup PHPUnit configured
Docs ✅ Included README + inline comments
Security ✅ Configured CSRF, validation, auth
Ready to Deploy ✅ YES Production-ready code

🎯 Key Takeaways

  • ✅ Complete Application: All features implemented and tested
  • ✅ No Code Errors: Production-ready code quality
  • ✅ Secure Setup: Credentials protected, git-ignored
  • ✅ Easy Setup: 5 simple steps to run
  • ✅ Well Organized: Clean architecture and file structure
  • ✅ Documented: Comprehensive README and code comments
  • ✅ Scalable: Built on Laravel, easy to extend

📞 Support

For issues or questions:

  1. Check application logs: storage/logs/laravel.log
  2. Review Laravel docs: https://laravel.com/docs/10.x
  3. Check database: db_school tables
  4. Verify configuration: .env file

Happy coding! 🚀

About

AI-enhanced enterprise school management system with OpenAI integration for automated student progress insights.

Topics

mysql php laravel openai school-management edutech ai-assistant

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages