# pedakihq/pedaki-community architecture

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

- Interactive diagram: https://gitdiagram.com/pedakihq/pedaki-community
- Repository: https://github.com/pedakihq/pedaki-community

## Overview

##### Main System Components

a) Frontend Layer:
- Next.js Application (app directory structure)
- Client-side Components
- Server Components
- Authentication UI
- Internationalization System

b) API Layer:
- tRPC API Routes
- NextAuth Authentication
- File Upload Handlers
- Health Check Endpoints

c) Service Layer:
- Academic Year Service
- Class Management Service
- Student Management Service
- Teacher Management Service
- File Storage Service
- Email Service

d) Data Layer:
- Prisma ORM
- Database
- File Storage (S3/Local)
- Cache System

##### Key Architectural Patterns to Highlight

Specific architectural elements:

a) Authentication Flow:
- NextAuth.js integration
- Session management
- Protected routes

b) Data Flow:
- tRPC router structure
- API endpoints
- Service layer interactions
- Database operations

c) Feature Modules:
- Class Generation Algorithm
- Student Import System
- User Management
- Settings Management

**┌─ Client Layer ─────────────────────┐**
- Next.js Pages/Components         │
- React Components                 │
- Store Management                 │
- ┬───────────────────┘
- ↓
**┌─ API Layer ────────────────────────┐**
- tRPC Routes                      │
- NextAuth Endpoints               │
- Upload Handlers                  │
- ┬───────────────────┘
- ↓
**┌─ Service Layer ─────────────────────┐**
- Business Logic                    │
- Data Processing                   │
- External Service Integration      │
- ┬───────────────────┘
- ↓
**┌─ Data Layer ───────────────────────┐**
- Prisma ORM                       │
- Database                         │
- File Storage                     │
- ┘

##### Important Connections

Key interactions:
- Authentication flow between frontend and NextAuth
- API requests through tRPC
- File upload paths
- Database operations through Prisma
- External service connections (Resend for email)

##### Deployment Architecture

Deployment structure:
- Docker containers
- Production vs Development environments
- Required external services

Remember to highlight the modular nature of the system, especially the packages structure which includes separate modules for algorithms, API, authentication, database, and services.

This will provide a comprehensive view of the system while maintaining clarity about how different components interact with each other.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles and classes
    classDef frontend fill:#3498db,color:white
    classDef api fill:#2ecc71,color:white
    classDef service fill:#f1c40f,color:black
    classDef data fill:#e74c3c,color:white
    classDef external fill:#9b59b6,color:white

    %% Frontend Layer
    subgraph Frontend
        NextApp["Next.js Application"]
        ClientComp["Client Components"]
        AuthUI["Authentication UI"]
        I18n["Internationalization"]
    end

    %% API Layer
    subgraph API
        TRPC["tRPC Routes"]
        NextAuth["NextAuth"]
        Upload["File Upload"]
        Health["Health Check"]
    end

    %% Service Layer
    subgraph Services
        AcademicYear["Academic Year Service"]
        ClassMgmt["Class Management"]
        StudentMgmt["Student Management"]
        TeacherMgmt["Teacher Management"]
        FileStorage["File Storage Service"]
        EmailService["Email Service"]
        Algorithm["Class Generation Algorithm"]
        Logger["Logger Service"]
    end

    %% Data Layer
    subgraph Data
        PrismaORM["Prisma ORM"]
        DB[(Database)]
        FileSystem["File Storage System"]
        Cache["Cache System"]
    end

    %% External Services
    ResendEmail["Resend Email Service"]:::external

    %% Connections
    NextApp --> TRPC
    NextApp --> NextAuth
    NextApp --> Upload
    NextApp --> Health
    
    TRPC --> AcademicYear
    TRPC --> ClassMgmt
    TRPC --> StudentMgmt
    TRPC --> TeacherMgmt
    TRPC --> FileStorage
    TRPC --> EmailService

    FileStorage --> FileSystem
    FileStorage --> Cache
    EmailService --> ResendEmail

    AcademicYear --> PrismaORM
    ClassMgmt --> PrismaORM
    StudentMgmt --> PrismaORM
    TeacherMgmt --> PrismaORM
    
    PrismaORM --> DB

    %% Click events
    click NextApp "https://github.com/PedakiHQ/pedaki-community/tree/main/app/src/app"
    click ClientComp "https://github.com/PedakiHQ/pedaki-community/tree/main/app/src/components"
    click AuthUI "https://github.com/PedakiHQ/pedaki-community/tree/main/app/src/app/[locale]/auth"
    click I18n "https://github.com/PedakiHQ/pedaki-community/tree/main/app/src/locales"
    click TRPC "https://github.com/PedakiHQ/pedaki-community/tree/main/app/src/app/api/t/[trpc]"
    click NextAuth "https://github.com/PedakiHQ/pedaki-community/blob/main/app/src/app/api/auth/[...nextauth]"
    click Upload "https://github.com/PedakiHQ/pedaki-community/tree/main/app/src/app/api/upload"
    click Health "https://github.com/PedakiHQ/pedaki-community/tree/main/app/src/app/api/health"
    click AcademicYear "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/services/src/academic-year"
    click ClassMgmt "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/services/src/classes"
    click StudentMgmt "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/services/src/students"
    click TeacherMgmt "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/services/src/teachers"
    click FileStorage "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/services/src/files"
    click EmailService "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/services/src/mail"
    click PrismaORM "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/db"
    click DB "https://github.com/PedakiHQ/pedaki-community/blob/main/packages/db/schema.prisma"
    click FileSystem "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/services/src/files/storage"
    click Cache "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/services/src/files/cache"
    click Algorithm "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/algorithms/src/generate_classes"
    click Logger "https://github.com/PedakiHQ/pedaki-community/tree/main/packages/logger"

    %% Style applications
    class NextApp,ClientComp,AuthUI,I18n frontend
    class TRPC,NextAuth,Upload,Health api
    class AcademicYear,ClassMgmt,StudentMgmt,TeacherMgmt,FileStorage,EmailService,Algorithm,Logger service
    class PrismaORM,DB,FileSystem,Cache data
```
