School Management System (SMS)

A comprehensive SaaS platform designed to streamline educational institution operations, from student enrollment to administrative tasks and parent-teacher communication.

Overview

Educational institutions today face increasing challenges in managing diverse operations. The School Management System (SMS) addresses these needs by providing a secure, cloud-based platform with a modular design, leveraging cutting-edge technology to ensure reliability, performance, and scalability.

Key Features

• Role-Based Dashboards

  • Admin dashboard with analytics and management tools
  • Teacher portal for classroom management
  • Student portal for accessing courses and assignments
  • Parent portal for tracking progress and communication
  • Responsive navigation with search functionality
  • Real-time notifications system

• Academic Management

  • Course and curriculum management
  • Assignment creation and grading
  • Attendance tracking
  • Progress reports and transcripts
  • Online examination system

• Administrative Tools

  • Student enrollment and registration
  • Staff management
  • Financial tracking and billing
  • Resource allocation
  • Reporting and analytics

• User Interface

  • Modern, intuitive design
  • Mobile-first responsive layout
  • Dark/light mode support
  • Accessible components following WCAG guidelines
  • Multi-language support

Technology Stack

• Frontend

  • Next.js 14 (App Router)
  • React 18
  • TailwindCSS for styling
  • TypeScript for type safety

• Development Tools

  • ESLint with Airbnb configuration
  • Prettier for code formatting
  • TypeScript for static typing
  • Husky for git hooks

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or higher)
• npm or yarn package manager
• Git
• VS Code (recommended editor)

Getting Started

1. Clone the repository (Requires access)

   git clone https://github.com/yourusername/school-lms.git
   cd school-lms

2. Install dependencies:

   yarn

   or

   npm install

3. Set up environment variables:

   cp .env.example .env.local

   Then edit .env.local with your configuration

4. Start the development server:

   yarn dev

   or

   npm run dev

5. Open http://localhost:3000 in your browser

Available Scripts

• yarn dev - Starts development server
• yarn build - Creates production build
• yarn start - Starts production server
• yarn lint - Runs ESLint
• yarn lint:fix - Fixes ESLint errors
• yarn format - Checks code formatting
• yarn format:fix - Fixes code formatting

Contributing

This is a private project. Contributing guidelines are available to authorized team members.

Authors

• @Dark-Developer93

Roadmap

• Add more tests
• Add more documentation
• Add more features
• ...

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Next.js team for the amazing framework
• Our dedicated development team for their hard work

---

Made with ❤️ by @Dark-Developer93