# bogdanisl/educode-server architecture

> Architecture diagram of the GitHub repository bogdanisl/educode-server, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bogdanisl/educode-server
- Repository: https://github.com/bogdanisl/educode-server

## Overview

Educode is an AdonisJS backend API for an educational platform. Its principal workflow is a frontend client calling authenticated or public API routes, which dispatch requests to controllers for account, course, lesson, task, and progress operations. Course content is represented as courses, modules, lessons, and tasks; code-task checking is a separate capability documented as using Judge0. The graph preserves major README capabilities, but sampled evidence does not show most controller internals or their model/service calls, so those links are omitted.

Main entry points: [`start/routes.ts`](https://github.com/bogdanisl/educode-server/blob/main/start/routes.ts) (HTTP routes), [`app/models/course/course.ts`](https://github.com/bogdanisl/educode-server/blob/main/app/models/course/course.ts) (Course), [`app/models/course/lesson.ts`](https://github.com/bogdanisl/educode-server/blob/main/app/models/course/lesson.ts) (Lesson), [`app/models/user/user_progress.ts`](https://github.com/bogdanisl/educode-server/blob/main/app/models/user/user_progress.ts) (User progress)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API and access"]
  node_routes["HTTP routes<br/>[routes.ts]"]
  node_kernel["HTTP middleware<br/>[kernel.ts]"]
end

subgraph group_learning["Learning content"]
  node_course_controller["Course management"]
  node_category_controller["Category management"]
  node_lesson_controller["Lesson access"]
  node_article_controller["Article management"]
  node_course_model[("Course<br/>[course.ts]")]
  node_category_model[("Course category<br/>[course_category.ts]")]
  node_module_model[("Course module<br/>[module.ts]")]
  node_lesson_model[("Lesson<br/>[lesson.ts]")]
end

subgraph group_accounts["Accounts and progress"]
  node_auth_controllers["Auth controllers"]
  node_progress_controller["Progress tracking"]
  node_users_controller["User management"]
  node_user_model[("User<br/>[user.ts]")]
  node_progress_model[("User progress<br/>[user_progress.ts]")]
end

subgraph group_execution["Task execution"]
  node_task_controller["Task checking"]
  node_task_model[("Task<br/>[task.ts]")]
  node_task_options[("Task options and examples")]
  node_languages["Task languages<br/>[task_languages.ts]"]
  node_code_runner["Code runner"]
end

node_client(("Frontend client"))
node_judge0{{"Judge0 API"}}
node_database[("MySQL database")]

node_client -->|"sends requests"| node_routes
node_routes -->|"uses middleware"| node_kernel
node_routes -->|"dispatches auth"| node_auth_controllers
node_routes -->|"dispatches course"| node_course_controller
node_routes -->|"dispatches categories"| node_category_controller
node_routes -->|"dispatches lessons"| node_lesson_controller
node_routes -->|"dispatches checks"| node_task_controller
node_routes -->|"dispatches progress"| node_progress_controller
node_routes -->|"dispatches users"| node_users_controller
node_routes -->|"dispatches articles"| node_article_controller
node_course_model -->|"belongs to"| node_category_model
node_course_model -->|"has many"| node_module_model
node_module_model -->|"belongs to"| node_course_model
node_module_model -->|"has many"| node_lesson_model
node_lesson_model -->|"belongs to"| node_module_model
node_lesson_model -->|"has many"| node_task_model
node_task_model -->|"belongs to"| node_lesson_model
node_task_model -->|"has many"| node_task_options
node_task_model -->|"maps language"| node_languages
node_progress_model -->|"belongs to"| node_user_model
node_progress_model -->|"belongs to"| node_course_model
node_progress_model -->|"belongs to"| node_lesson_model
node_task_controller -.->|"may invoke"| node_code_runner
node_code_runner -->|"checks code"| node_judge0
node_course_model -.->|"persists records"| node_database
node_user_model -.->|"persists records"| node_database
node_progress_model -.->|"persists records"| node_database

click node_routes "https://github.com/bogdanisl/educode-server/blob/main/start/routes.ts"
click node_kernel "https://github.com/bogdanisl/educode-server/blob/main/start/kernel.ts"
click node_auth_controllers "https://github.com/bogdanisl/educode-server/tree/main/app/controllers/auth"
click node_course_controller "https://github.com/bogdanisl/educode-server/blob/main/app/controllers/courses_controller.ts"
click node_category_controller "https://github.com/bogdanisl/educode-server/blob/main/app/controllers/categories_controller.ts"
click node_lesson_controller "https://github.com/bogdanisl/educode-server/blob/main/app/controllers/lessons_controller.ts"
click node_task_controller "https://github.com/bogdanisl/educode-server/blob/main/app/controllers/tasks_controller.ts"
click node_progress_controller "https://github.com/bogdanisl/educode-server/blob/main/app/controllers/user_progress_controller.ts"
click node_users_controller "https://github.com/bogdanisl/educode-server/blob/main/app/controllers/users_controller.ts"
click node_article_controller "https://github.com/bogdanisl/educode-server/blob/main/app/controllers/article_controllet.ts"
click node_course_model "https://github.com/bogdanisl/educode-server/blob/main/app/models/course/course.ts"
click node_category_model "https://github.com/bogdanisl/educode-server/blob/main/app/models/course/course_category.ts"
click node_module_model "https://github.com/bogdanisl/educode-server/blob/main/app/models/course/module.ts"
click node_lesson_model "https://github.com/bogdanisl/educode-server/blob/main/app/models/course/lesson.ts"
click node_task_model "https://github.com/bogdanisl/educode-server/blob/main/app/models/task/task.ts"
click node_task_options "https://github.com/bogdanisl/educode-server/tree/main/app/models/task"
click node_languages "https://github.com/bogdanisl/educode-server/blob/main/app/constants/task_languages.ts"
click node_user_model "https://github.com/bogdanisl/educode-server/blob/main/app/models/user/user.ts"
click node_progress_model "https://github.com/bogdanisl/educode-server/blob/main/app/models/user/user_progress.ts"
click node_code_runner "https://github.com/bogdanisl/educode-server/blob/main/app/services/code-runner.service.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_routes,node_kernel,node_client toneBlue
class node_course_controller,node_category_controller,node_lesson_controller,node_article_controller,node_course_model,node_category_model,node_module_model,node_lesson_model,node_database toneAmber
class node_auth_controllers,node_progress_controller,node_users_controller,node_user_model,node_progress_model,node_judge0 toneMint
class node_task_controller,node_task_model,node_task_options,node_languages,node_code_runner toneRose
```

## Components

### API and access

- [HTTP routes](https://github.com/bogdanisl/educode-server/blob/main/start/routes.ts): `start/routes.ts`
- [HTTP middleware](https://github.com/bogdanisl/educode-server/blob/main/start/kernel.ts): `start/kernel.ts`

### Learning content

- [Course management](https://github.com/bogdanisl/educode-server/blob/main/app/controllers/courses_controller.ts): `app/controllers/courses_controller.ts`
- [Category management](https://github.com/bogdanisl/educode-server/blob/main/app/controllers/categories_controller.ts): `app/controllers/categories_controller.ts`
- [Lesson access](https://github.com/bogdanisl/educode-server/blob/main/app/controllers/lessons_controller.ts): `app/controllers/lessons_controller.ts`
- [Article management](https://github.com/bogdanisl/educode-server/blob/main/app/controllers/article_controllet.ts): `app/controllers/article_controllet.ts`
- [Course](https://github.com/bogdanisl/educode-server/blob/main/app/models/course/course.ts): `app/models/course/course.ts`
- [Course category](https://github.com/bogdanisl/educode-server/blob/main/app/models/course/course_category.ts): `app/models/course/course_category.ts`
- [Course module](https://github.com/bogdanisl/educode-server/blob/main/app/models/course/module.ts): `app/models/course/module.ts`
- [Lesson](https://github.com/bogdanisl/educode-server/blob/main/app/models/course/lesson.ts): `app/models/course/lesson.ts`

### Accounts and progress

- [Auth controllers](https://github.com/bogdanisl/educode-server/tree/main/app/controllers/auth): `app/controllers/auth`
- [Progress tracking](https://github.com/bogdanisl/educode-server/blob/main/app/controllers/user_progress_controller.ts): `app/controllers/user_progress_controller.ts`
- [User management](https://github.com/bogdanisl/educode-server/blob/main/app/controllers/users_controller.ts): `app/controllers/users_controller.ts`
- [User](https://github.com/bogdanisl/educode-server/blob/main/app/models/user/user.ts): `app/models/user/user.ts`
- [User progress](https://github.com/bogdanisl/educode-server/blob/main/app/models/user/user_progress.ts): `app/models/user/user_progress.ts`

### Task execution

- [Task checking](https://github.com/bogdanisl/educode-server/blob/main/app/controllers/tasks_controller.ts): `app/controllers/tasks_controller.ts`
- [Task](https://github.com/bogdanisl/educode-server/blob/main/app/models/task/task.ts): `app/models/task/task.ts`
- [Task options and examples](https://github.com/bogdanisl/educode-server/tree/main/app/models/task): `app/models/task`
- [Task languages](https://github.com/bogdanisl/educode-server/blob/main/app/constants/task_languages.ts): `app/constants/task_languages.ts`
- [Code runner](https://github.com/bogdanisl/educode-server/blob/main/app/services/code-runner.service.ts): `app/services/code-runner.service.ts`

### Other components

- **Frontend client**
- **Judge0 API**
- **MySQL database**

## Connections

- Frontend client → HTTP routes: sends requests (evidence: `start/routes.ts`)
- HTTP routes → HTTP middleware: uses middleware (evidence: `start/routes.ts`)
- HTTP routes → Auth controllers: dispatches auth (evidence: `start/routes.ts`)
- HTTP routes → Course management: dispatches course (evidence: `start/routes.ts`)
- HTTP routes → Category management: dispatches categories (evidence: `start/routes.ts`)
- HTTP routes → Lesson access: dispatches lessons (evidence: `start/routes.ts`)
- HTTP routes → Task checking: dispatches checks (evidence: `start/routes.ts`)
- HTTP routes → Progress tracking: dispatches progress (evidence: `start/routes.ts`)
- HTTP routes → User management: dispatches users (evidence: `start/routes.ts`)
- HTTP routes → Article management: dispatches articles (evidence: `start/routes.ts`)
- Course → Course category: belongs to (evidence: `app/models/course/course.ts`)
- Course → Course module: has many (evidence: `app/models/course/course.ts`)
- Course module → Course: belongs to (evidence: `app/models/course/module.ts`)
- Course module → Lesson: has many (evidence: `app/models/course/module.ts`)
- Lesson → Course module: belongs to (evidence: `app/models/course/lesson.ts`)
- Lesson → Task: has many (evidence: `app/models/course/lesson.ts`)
- Task → Lesson: belongs to (evidence: `app/models/task/task.ts`)
- Task → Task options and examples: has many (evidence: `app/models/task/task.ts`)
- Task → Task languages: maps language (evidence: `app/models/task/task.ts`)
- User progress → User: belongs to (evidence: `app/models/user/user_progress.ts`)
- User progress → Course: belongs to (evidence: `app/models/user/user_progress.ts`)
- User progress → Lesson: belongs to (evidence: `app/models/user/user_progress.ts`)
- Task checking → Code runner: may invoke
- Code runner → Judge0 API: checks code
- Course → MySQL database: persists records
- User → MySQL database: persists records
- User progress → MySQL database: persists records
