# kevin0929/nchuoj architecture

> Architecture diagram of the GitHub repository kevin0929/nchuoj, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kevin0929/nchuoj
- Repository: https://github.com/kevin0929/nchuoj

## Overview

##### Main Components

A. Frontend Layer:
- Static Assets (CSS, JS, Images)
- Templates (Admin and User views)
- Clear separation between admin and user interfaces

B. Backend Layer:
- API Services
- Core Services
- Database Models
- Authentication System

C. Judge System:
- Judge0 Integration (separate component)
- Submission Processing
- Test Case Handling

D. Database Layer:
- Major entities (User, Course, Problem, Submission, etc.)

##### Component Relationships

**User Interface ↔ API Layer ↔ Services ↔ Database**
- ↕
- Judge System

##### Detailed Component Breakdown

A. API Components (from /apis):
- Authentication (auth.py)
- Course Management (course.py)
- Problem Management (problem.py)
- Submission Handling (submission.py)
- User Management (user.py)
- Announcement System (announcement.py)
- Homework Management (homework.py)

B. Data Models (from /model):
- User
- Course
- CourseUser (Many-to-Many relationship)
- Problem
- Submission
- TestCase
- Homework
- Announcement

C. Services Layer (from /service):
- Course Service
- Submit Service
- User Service

##### Important Architectural Elements to Highlight

A. Authentication Flow:
- Login process
- Role-based access control (Admin/User)

B. Submission Flow:
- Problem submission path
- Judge0 integration
- Result processing
- Feedback loop to user

C. Course Management:
- Course-User relationships
- Homework assignment flow
- Problem sets organization

##### Technical Stack Indicators

- Python/Flask (Backend framework)
- SQLAlchemy (ORM)
- Alembic (Database migrations)
- Judge0 (Code execution engine)
- Docker (Containerization)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and Classes
    classDef frontend fill:#3498db,stroke:#2980b9,color:white
    classDef api fill:#2ecc71,stroke:#27ae60,color:white
    classDef service fill:#f1c40f,stroke:#f39c12,color:black
    classDef database fill:#e74c3c,stroke:#c0392b,color:white
    classDef judge fill:#9b59b6,stroke:#8e44ad,color:white
    classDef external fill:#95a5a6,stroke:#7f8c8d,color:white

    %% Frontend Layer
    subgraph Frontend
        StaticAssets["Static Assets"]
        AdminUI["Admin Interface"]
        UserUI["User Interface"]
        CSS["CSS Resources"]
        JS["JavaScript"]
    end

    %% API Layer
    subgraph APIs
        AuthAPI["Authentication API"]
        CourseAPI["Course API"]
        ProblemAPI["Problem API"]
        SubmissionAPI["Submission API"]
        UserAPI["User API"]
        AnnouncementAPI["Announcement API"]
        HomeworkAPI["Homework API"]
    end

    %% Service Layer
    subgraph Services
        CourseService["Course Service"]
        SubmitService["Submit Service"]
        UserService["User Service"]
    end

    %% Database Models
    subgraph Database
        User["User Model"]
        Course["Course Model"]
        CourseUser["CourseUser Model"]
        Problem["Problem Model"]
        Submission["Submission Model"]
        TestCase["TestCase Model"]
        Homework["Homework Model"]
        Announcement["Announcement Model"]
    end

    %% Judge System
    subgraph JudgeSystem
        Judge0["Judge0 Integration"]
        ResultProcessor["Result Processor"]
    end

    %% Relationships
    StaticAssets --> AdminUI & UserUI
    CSS & JS --> StaticAssets

    AdminUI & UserUI --> AuthAPI
    AdminUI & UserUI --> CourseAPI
    AdminUI & UserUI --> ProblemAPI
    AdminUI & UserUI --> SubmissionAPI
    AdminUI & UserUI --> UserAPI
    AdminUI & UserUI --> AnnouncementAPI
    AdminUI & UserUI --> HomeworkAPI

    AuthAPI & CourseAPI & ProblemAPI & SubmissionAPI & UserAPI & AnnouncementAPI & HomeworkAPI --> CourseService & SubmitService & UserService

    CourseService --> Course & CourseUser
    SubmitService --> Submission & TestCase
    UserService --> User

    SubmitService --> Judge0
    Judge0 --> ResultProcessor
    ResultProcessor --> SubmitService

    %% Click Events
    click StaticAssets "https://github.com/kevin0929/NCHUOJ/tree/main/backend/nchuoj/static"
    click AdminUI "https://github.com/kevin0929/NCHUOJ/tree/main/backend/nchuoj/templates/admin"
    click UserUI "https://github.com/kevin0929/NCHUOJ/tree/main/backend/nchuoj/templates/user"
    click CSS "https://github.com/kevin0929/NCHUOJ/tree/main/backend/nchuoj/static/css"
    click JS "https://github.com/kevin0929/NCHUOJ/tree/main/backend/nchuoj/static/js"
    
    click AuthAPI "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/apis/auth.py"
    click CourseAPI "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/apis/course.py"
    click ProblemAPI "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/apis/problem.py"
    click SubmissionAPI "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/apis/submission.py"
    click UserAPI "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/apis/user.py"
    click AnnouncementAPI "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/apis/announcement.py"
    click HomeworkAPI "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/apis/homework.py"
    
    click User "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/model/user.py"
    click Course "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/model/course.py"
    click CourseUser "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/model/course_user.py"
    click Problem "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/model/problem.py"
    click Submission "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/model/submission.py"
    click TestCase "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/model/testcase.py"
    click Homework "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/model/homework.py"
    click Announcement "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/model/announcement.py"
    
    click CourseService "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/service/course_service.py"
    click SubmitService "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/service/submit_service.py"
    click UserService "https://github.com/kevin0929/NCHUOJ/blob/main/backend/nchuoj/service/user_service.py"
    
    click Judge0 "https://github.com/kevin0929/NCHUOJ/tree/main/judge0"

    %% Style Applications
    class StaticAssets,AdminUI,UserUI,CSS,JS frontend
    class AuthAPI,CourseAPI,ProblemAPI,SubmissionAPI,UserAPI,AnnouncementAPI,HomeworkAPI api
    class CourseService,SubmitService,UserService service
    class User,Course,CourseUser,Problem,Submission,TestCase,Homework,Announcement database
    class Judge0,ResultProcessor judge
```
