Skip to content

database_design.md

Latest commit

 

History

History
382 lines (321 loc) · 6.19 KB

database_design.md

File metadata and controls

382 lines (321 loc) · 6.19 KB
Raw

FLN Platform Database Design

1. System Architecture

                           INDIA
                              │
                 ┌────────────┴────────────┐
                 │ Master Collections      │
                 └────────────┬────────────┘
                              │
                         States Collection
                              │
                              ▼
                      Districts Collection
                              │
                              ▼
                        Blocks Collection
                              │
                              ▼
                        Schools Collection
                              │
               ┌──────────────┴──────────────┐
               │                             │
               ▼                             ▼
        Teachers Collection           Classes Collection
               │                             │
               └──────────────┬──────────────┘
                              │
                              ▼
                      Students Collection
                              │
                              ▼
                 Student Profiles Collection
                              │
               ┌──────────────┼──────────────┐
               │              │              │
               ▼              ▼              ▼
        Assessments     Competencies  Recommendations
               │
               ▼
      Assessment Questions
               │
               ▼
      Generated Question Paper
               │
               ▼
        Offline Assessment
               │
               ▼
      Answer Sheet Upload
               │
               ▼
      OCR & Evaluation
               │
               ▼
      Student Profile Updated

2. Master Collections

States

{
  "_id": "...",
  "stateCode": "PB",
  "stateName": "Punjab"
}

Districts

{
  "_id": "...",
  "districtCode": "RPR",
  "districtName": "Rupnagar",
  "stateId": "stateId"
}

Blocks

{
  "_id": "...",
  "blockCode": "B001",
  "blockName": "Rupnagar",
  "districtId": "districtId"
}

3. Operational Collections

Schools

{
  "_id": "...",
  "schoolCode": "015",
  "schoolName": "Government Primary School",
  "stateId": "...",
  "districtId": "...",
  "blockId": "...",
  "pincode": "140001"
}

Teachers

{
  "_id": "...",
  "teacherId": "T0001",
  "firstName": "Sejal",
  "lastName": "Kumari",
  "email": "teacher@example.com",
  "phone": "9876543210",
  "password": "hashedPassword",
  "schoolId": "...",
  "isActive": true,
  "createdBy": "adminId"
}

Classes

{
  "_id": "...",
  "className": "Class 1",
  "teacherId": "...",
  "schoolId": "..."
}

Students

{
  "_id": "...",
  "studentId": "PB-RPR-015-0001",
  "name": "Rahul Kumar",
  "age": 6,
  "gender": "Male",
  "classId": "...",
  "teacherId": "...",
  "schoolId": "...",
  "createdAt": "..."
}

Student Profiles

{
  "_id": "...",
  "studentId": "...",
  "currentLevel": "Level 2",
  "weakTopics": [
    "Addition",
    "Counting"
  ],
  "strongTopics": [
    "Shapes"
  ],
  "recommendedWorksheets": [],
  "lastAssessment": "assessmentId"
}

4. Assessment Collections

Question Bank

  • Question
  • Difficulty
  • Topic
  • Learning Outcome
  • Bloom's Level
  • Correct Answer

Assessments

assessmentId
teacherId
classId
testType
generatedAt

Assessment Questions

assessmentId
questionId
questionOrder

Student Assessments

studentId
assessmentId
score
level
status

5. AI / OCR Collections

Answer Sheets

  • studentId
  • assessmentId
  • imageUrl

OCR Results

  • ocrText
  • confidence

Evaluation Results

  • obtainedMarks
  • competencyAnalysis
  • suggestedLevel

6. Relationships

State
 │
 ▼
District
 │
 ▼
Block
 │
 ▼
School
 │
 ▼
Teacher
 │
 ▼
Class
 │
 ▼
Student
 │
 ▼
Student Profile
 │
 ▼
Assessment

7. Admin Flow

Super Admin
      │
      ▼
Import States
      │
      ▼
Import Districts
      │
      ▼
Import Blocks
      │
      ▼
Create School
      │
      ▼
Create Teacher

8. Teacher Flow

Teacher Login
      │
      ▼
Select Class
      │
      ▼
Add Student
      │
      ▼
Student ID Generated
      │
      ▼
Generate Baseline Test
      │
      ▼
Generate PDF
      │
      ▼
Offline Assessment
      │
      ▼
Upload Answer Sheet
      │
      ▼
OCR
      │
      ▼
Evaluation
      │
      ▼
Update Student Profile
      │
      ▼
Generate Recommendation

9. Student ID Format

<State Code>-<District Code>-<School Code>-<Sequence>

Example:

PB-RPR-015-0001

10. Folder Classification

Master Collections
------------------
states
districts
blocks

Operational Collections
-----------------------
schools
teachers
classes
students
studentProfiles

Assessment Collections
----------------------
questionBank
assessments
assessmentQuestions
studentAssessments

AI Collections
--------------
answerSheets
ocrResults
evaluationResults

Analytics
----------
competencies
recommendations
reports