Skip to content

kssush/School_management_system

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 

Repository files navigation

⚛️ React 🟢 Node.js 🐘 PostgreSQL 🛠️ RTK Query 🎨 Figma

School management system

A platform for modern educational institutions that provides:

  • For administrators: monitoring staff and student accounts, academic year progress, and predictive analytics to support student academic achievement.
  • For teachers: effective tools for lesson planning, assignment allocation, and grading.
  • For students and parents: a portal for viewing assignments, tracking grades, and monitoring progress.
  • For all participants of the system, view class schedules and teachers of their profiles.


🎨 UI/UX Design

View Design System: the design is here




🚀 Installation Steps

Clone repository

git clone https://github.com/kssush/School_management_system.git
cd school_management_system

Install dependencies

cd server
npm install

cd client
npm install

Database setup

  • Create a new database in PostgreSQL named SchoolMS (example)

Environment configuration

  • Create .env file in the server folder with:
PORT=5000
DB_NAME=SchoolMS                 //name your db
DB_USER=postgres
DB_PASSWORD=passwd               //password your db
DB_HOST=localhost
DB_PORT=0000                     //port your db
SECRET_KEY=random_key            
JWT_ACCESS_SECRET_KEY=yourjwt    
JWT_REFRESH_SECRET_KEY=yourjwt   

Run the application

cd server
npm run dev

cd client
npm start

Migration

  • Create a file ./config/config.js based on the file example ./config/config.example.js and RUN command
npx sequelize-cli db:migrate

🐛 Known Issues

  • add a mobile version + responsive (layout in rem units, write media queries for different screen sizes)
  • add preloaders and smooth animations
  • handle more unique errors on the server (currently handling custom exceptions, with a common handler for others)

📄 License

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

👥 Author (kssush)

Telegram: @Stasi4ekKk