A modern, comprehensive web-based School Management System built with React.js and Node.js, designed to streamline educational institution operations with a focus on usability, scalability, and security.
- 🎯 User-Centric Design - Intuitive interface for administrators, teachers, and staff
- 🔒 Secure Authentication - JWT-based authentication with role-based access control
- 📱 Responsive Design - Works seamlessly across desktop, tablet, and mobile devices
- ⚡ Real-time Operations - Fast and efficient data management
- 🔧 Modular Architecture - Easily extensible and maintainable codebase
- Features
- Technology Stack
- Quick Start
- Documentation
- System Architecture
- Project Structure
- API Reference
- Contributing
- Security
- License
- Support
- School Profile Setup: Complete school information management with document uploads
- Multi-institution Support: Designed to handle multiple educational institutions
- Branding & Customization: Upload school logos and customize profile information
- Regulatory Compliance: Track registration numbers, licenses, and TIN information
- Secure Authentication: JWT-based login system with encrypted passwords
- Role-based Access: Different permission levels for administrators and staff
- User Profiles: Comprehensive user information management
- Session Management: Secure session handling with automatic logout
- Class/Course Management: Create and manage classes across different academic years
- Student Enrollment: Comprehensive student information system
- Student Records: Detailed student profiles with photos and family information
- Bulk Operations: Efficient handling of multiple student records
- Real-time Statistics: Live dashboard with key metrics
- Visual Analytics: Charts and graphs for data visualization
- Report Generation: Comprehensive reporting system
- Data Export: Export data in various formats
- Advanced Search: Search students, classes, and records
- Filter Options: Multiple filtering criteria for easy data retrieval
- Quick Access: Fast navigation to frequently used features
- React 18.x - Modern UI library with hooks and functional components
- Vite - Fast build tool and development server
- Tailwind CSS - Utility-first CSS framework
- Axios - HTTP client for API communications
- React Router - Client-side routing
- Lucide React - Modern icon library
- Node.js 20.x - JavaScript runtime environment
- Express.js 4.x - Web application framework
- Sequelize 6.x - Promise-based ORM for SQL databases
- SQLite 3.x - Lightweight, file-based database
- JWT - JSON Web Tokens for authentication
- Bcrypt - Password hashing library
- Multer - File upload middleware
- ESLint - Code linting and style enforcement
- Nodemon - Auto-restart development server
- PostCSS - CSS post-processing
- Git - Version control system
Ensure you have the following installed:
-
Clone the repository
git clone https://github.com/Arison99/School-Management-System.git cd School-Management-System -
Install Backend Dependencies
cd backend npm install -
Install Frontend Dependencies
cd ../frontend npm install -
Environment Setup
cd ../backend cp .env.example .env # Edit .env file with your configuration
-
Start the Application
Backend (Terminal 1):
cd backend npm run devFrontend (Terminal 2):
cd frontend npm run dev -
Access the Application
- Frontend: http://localhost:5173
- Backend API: http://localhost:6001
On first run, create an account through the signup process. The system will guide you through school profile setup.
- 📖 User Guide - Complete user manual with screenshots
- 🔧 Installation Guide - Detailed setup instructions
- ⚙️ Configuration Guide - Environment and system configuration
- 🚀 Deployment Guide - Production deployment instructions
- 🏗️ Architecture Guide - System design and architecture overview
- 📡 API Documentation - Complete API reference and examples
- 🔒 Security Guide - Security implementation and best practices
- 🧪 Testing Guide - Testing strategies and implementation
- ❓ FAQ - Frequently asked questions and solutions
- 🐛 Troubleshooting - Common issues and fixes
- 📝 Changelog - Version history and updates
- 🤝 Contributing Guidelines - How to contribute to the project
The School Management System follows a layered architecture pattern:
┌─────────────────────────────────────────────────────────────┐
│ Frontend (React) │
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │
│ │ Pages │ │ Components │ │ API Services │ │
│ │ │ │ │ │ │ │
│ └─────────────┘ └─────────────┘ └─────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
│
HTTP/HTTPS
│
┌─────────────────────────────────────────────────────────────┐
│ Backend (Node.js) │
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │
│ │ Routes │ │ Controllers │ │ Middleware │ │
│ └─────────────┘ └─────────────┘ └─────────────────────────┘ │
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │
│ │ Services │ │ Repositories│ │ Models │ │
│ └─────────────┘ └─────────────┘ └─────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
│
Sequelize ORM
│
┌─────────────────────────────────────────────────────────────┐
│ Database (SQLite) │
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │
│ │ Users │ │ Schools │ │ Classes │ │
│ └─────────────┘ └─────────────┘ └─────────────────────────┘ │
│ ┌─────────────┐ │
│ │ Students │ │
│ └─────────────┘ │
└─────────────────────────────────────────────────────────────┘
- Frontend Layer: React-based SPA with responsive design
- API Layer: RESTful Express.js server with JWT authentication
- Business Logic: Service layer handling core operations
- Data Access: Repository pattern with Sequelize ORM
- Database: SQLite for development, easily scalable to PostgreSQL/MySQL
School-Management-System/
├── 📁 backend/ # Backend server
│ ├── 📁 src/
│ │ ├── 📁 config/ # Database and app configuration
│ │ ├── 📁 controllers/ # Request handlers
│ │ ├── 📁 middleware/ # Custom middleware
│ │ ├── 📁 models/ # Database models (Sequelize)
│ │ ├── 📁 repositories/ # Data access layer
│ │ ├── 📁 routes/ # API route definitions
│ │ └── 📁 services/ # Business logic layer
│ ├── 📁 uploads/ # File upload storage
│ ├── 📄 server.js # Server entry point
│ ├── 📄 package.json # Backend dependencies
│ └── 📄 .env # Environment variables
├── 📁 frontend/ # Frontend application
│ ├── 📁 src/
│ │ ├── 📁 api/ # API service clients
│ │ ├── 📁 assets/ # Static assets
│ │ ├── 📁 Pages/ # React page components
│ │ ├── 📄 App.jsx # Main App component
│ │ └── 📄 main.jsx # Application entry point
│ ├── 📄 index.html # HTML template
│ ├── 📄 package.json # Frontend dependencies
│ └── 📄 vite.config.js # Vite configuration
├── 📁 docs/ # Documentation files
├── 📄 README.md # This file
├── 📄 CONTRIBUTING.md # Contribution guidelines
├── 📄 LICENSE # License information
└── 📄 CHANGELOG.md # Version history
Base URL: http://localhost:6001/api
POST /signup- User registrationPOST /login- User authentication
GET /schools/my-school- Get current user's schoolPOST /schools- Create school profilePUT /schools- Update school informationGET /schools/stats- Get school statistics
GET /classes- Get all classesPOST /classes- Create new classPUT /classes/:id- Update classDELETE /classes/:id- Delete class
POST /classes/:id/students- Add student to classPUT /classes/:classId/students/:studentId- Update studentDELETE /classes/:classId/students/:studentId- Remove studentGET /students/search- Search students
For detailed API documentation with examples, see API Documentation.
We welcome contributions from the community! Please read our Contributing Guidelines for details on:
- 📝 How to submit issues
- 🔧 Setting up development environment
- 📋 Code style and standards
- 🧪 Testing requirements
- 📤 Pull request process
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Security is a top priority. This system implements:
- JWT Authentication - Secure token-based authentication
- Password Encryption - Bcrypt hashing for password security
- Input Validation - Comprehensive data validation
- SQL Injection Prevention - Parameterized queries via Sequelize
- File Upload Security - Restricted file types and size limits
For detailed security information, see Security Guide.
This project is licensed under the MIT License - see the LICENSE file for details.
- 📖 Check the User Guide for common tasks
- ❓ Read the FAQ for frequently asked questions
- 🐛 Review Troubleshooting for common issues
- 💡 Search existing issues
- 🐛 Bug Reports: GitHub Issues
- 💡 Feature Requests: GitHub Discussions
- Lead Developer: Arison99
- Contributors: View all contributors
⭐ Star this repository if you find it helpful!
🏠 Website | 📖 Documentation | 🐛 Report Bug | 💡 Request Feature
Made with ❤️ by the Arison99