/SDARS

A basic school management app

Primary LanguageJavaScript

school management system

This repository is the place for our draft codes.

assumtions before using

  • every username is unique and is handed over to the students before using this system
  • users are not supposed to reload the page as it will logout them
  • creation of new users is out of the scope for the current implementation.

frontend

To start the frontend, follow the below steps:

  • cd frontend
  • npm i
  • npm start

if you follow these correctly it should open a browser window with the project

  • note that you'd need nodeJS to be able to run this project

Entities used on frontend

  1. username: a unique identifer for a user of the project, each username has a privilege(student, teacher or parent).
  2. circular: a global level circular for everyone
  3. results: student specific results
  4. assignments: class specific assignments
  5. progress: student specific progress
  6. attedence: student specific attedence
  7. fees: student specific fees

Note for backend collaborators

  • apis specs are defined in the misc folder
  • assume all fields return strings, unless a type is specified in the conventional way in the api.
  • /login does not need to send an id field as usernames gotten from login screen act as unique identifier
  • origin for fetch request can be set inside frontend/src/config (for eg, localhost:8000).

backend

backend instrcutions go here!