# codebyartem/english-api architecture

> Architecture diagram of the GitHub repository codebyartem/english-api, 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/codebyartem/english-api
- Repository: https://github.com/codebyartem/english-api

## Overview

The README describes a NestJS starter rather than documenting a product workflow. The sampled runtime code supports an API for registration/login and learning content, plus assignment submission, automatic scoring, and staff review. PostgreSQL is configured through TypeORM. Edges reflect shown controller/service calls, indexed module wiring, or entity relationships; unsampled behavior is not inferred.

Main entry points: [`src/content/entities/lesson.entity.ts`](https://github.com/codebyartem/english-api/blob/main/src/content/entities/lesson.entity.ts) (Lesson), [`src/app.module.ts`](https://github.com/codebyartem/english-api/blob/main/src/app.module.ts) (Nest application), [`src/content/seed.service.ts`](https://github.com/codebyartem/english-api/blob/main/src/content/seed.service.ts) (Content seeding), [`src/content/entities/unit.entity.ts`](https://github.com/codebyartem/english-api/blob/main/src/content/entities/unit.entity.ts) (Unit)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API entry points"]
  node_app["Nest application<br/>[app.module.ts]"]
  node_auth_controller["Auth endpoints<br/>[auth.controller.ts]"]
  node_content_controller["Content endpoints"]
  node_assignment_controller["Assignment endpoints"]
  node_submission_controller["Submission endpoints"]
end

subgraph group_identity["Identity and users"]
  node_auth_service["Authentication<br/>[auth.service.ts]"]
  node_users_service["User management<br/>[users.service.ts]"]
  node_user["User account<br/>[user.entity.ts]"]
  node_role["User roles<br/>[role.enum.ts]"]
end

subgraph group_content["Learning content"]
  node_content_service["Content access<br/>[content.service.ts]"]
  node_content_seed["Content seeding<br/>[seed.service.ts]"]
  node_textbook["Textbook<br/>[textbook.entity.ts]"]
  node_unit["Unit<br/>[unit.entity.ts]"]
  node_lesson["Lesson<br/>[lesson.entity.ts]"]
  node_exercise["Exercise<br/>[exercise.entity.ts]"]
  node_material["Material<br/>[material.entity.ts]"]
end

subgraph group_assignments["Assignments"]
  node_assignments_service["Assignment workflow"]
  node_assignment["Assignment record"]
  node_submission["Submission record"]
end

subgraph group_storage["Persistence"]
  node_postgres[("PostgreSQL")]
end

node_client(("API client"))

node_client -->|"requests"| node_auth_controller
node_client -->|"requests"| node_content_controller
node_client -->|"requests"| node_assignment_controller
node_client -->|"requests"| node_submission_controller
node_auth_controller -->|"delegates"| node_auth_service
node_auth_service -->|"looks up users"| node_users_service
node_users_service -->|"creates and finds"| node_user
node_user -->|"uses role"| node_role
node_content_controller -->|"delegates"| node_content_service
node_app -->|"registers module"| node_auth_controller
node_app -->|"registers module"| node_content_controller
node_app -->|"registers module"| node_assignment_controller
node_app -->|"registers module"| node_submission_controller
node_assignment_controller -->|"delegates"| node_assignments_service
node_submission_controller -->|"delegates"| node_assignments_service
node_assignments_service -->|"loads lesson exercises"| node_lesson
node_textbook -->|"has units"| node_unit
node_unit -->|"has lessons"| node_lesson
node_unit -->|"has materials"| node_material
node_lesson -->|"has exercises"| node_exercise
node_assignment -->|"references lesson"| node_lesson
node_submission -->|"may reference"| node_assignment
node_submission -->|"references lesson"| node_lesson
node_submission -->|"belongs to student"| node_user
node_app -->|"configures TypeORM"| node_postgres
node_users_service -->|"queries and saves"| node_postgres
node_assignments_service -->|"queries and saves"| node_postgres
node_content_service -->|"uses repositories"| node_postgres
node_content_seed -->|"populates content"| node_textbook
node_content_seed -->|"populates content"| node_unit
node_content_seed -->|"populates content"| node_lesson
node_content_seed -->|"populates content"| node_exercise
node_content_seed -->|"populates content"| node_material

click node_app "https://github.com/codebyartem/english-api/blob/main/src/app.module.ts"
click node_auth_controller "https://github.com/codebyartem/english-api/blob/main/src/auth/auth.controller.ts"
click node_content_controller "https://github.com/codebyartem/english-api/blob/main/src/content/content.controller.ts"
click node_assignment_controller "https://github.com/codebyartem/english-api/blob/main/src/assignments/assignments.controller.ts"
click node_submission_controller "https://github.com/codebyartem/english-api/blob/main/src/assignments/submissions.controller.ts"
click node_auth_service "https://github.com/codebyartem/english-api/blob/main/src/auth/auth.service.ts"
click node_users_service "https://github.com/codebyartem/english-api/blob/main/src/users/users.service.ts"
click node_user "https://github.com/codebyartem/english-api/blob/main/src/users/user.entity.ts"
click node_role "https://github.com/codebyartem/english-api/blob/main/src/common/role.enum.ts"
click node_content_service "https://github.com/codebyartem/english-api/blob/main/src/content/content.service.ts"
click node_content_seed "https://github.com/codebyartem/english-api/blob/main/src/content/seed.service.ts"
click node_textbook "https://github.com/codebyartem/english-api/blob/main/src/content/entities/textbook.entity.ts"
click node_unit "https://github.com/codebyartem/english-api/blob/main/src/content/entities/unit.entity.ts"
click node_lesson "https://github.com/codebyartem/english-api/blob/main/src/content/entities/lesson.entity.ts"
click node_exercise "https://github.com/codebyartem/english-api/blob/main/src/content/entities/exercise.entity.ts"
click node_material "https://github.com/codebyartem/english-api/blob/main/src/content/entities/material.entity.ts"
click node_assignments_service "https://github.com/codebyartem/english-api/blob/main/src/assignments/assignments.service.ts"
click node_assignment "https://github.com/codebyartem/english-api/blob/main/src/assignments/entities/assignment.entity.ts"
click node_submission "https://github.com/codebyartem/english-api/blob/main/src/assignments/entities/submission.entity.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_app,node_auth_controller,node_content_controller,node_assignment_controller,node_submission_controller,node_client toneBlue
class node_auth_service,node_users_service,node_user,node_role toneAmber
class node_content_service,node_content_seed,node_textbook,node_unit,node_lesson,node_exercise,node_material toneMint
class node_assignments_service,node_assignment,node_submission toneRose
class node_postgres toneIndigo
```

## Components

### API entry points

- [Nest application](https://github.com/codebyartem/english-api/blob/main/src/app.module.ts): `src/app.module.ts`
- [Auth endpoints](https://github.com/codebyartem/english-api/blob/main/src/auth/auth.controller.ts): `src/auth/auth.controller.ts`
- [Content endpoints](https://github.com/codebyartem/english-api/blob/main/src/content/content.controller.ts): `src/content/content.controller.ts`
- [Assignment endpoints](https://github.com/codebyartem/english-api/blob/main/src/assignments/assignments.controller.ts): `src/assignments/assignments.controller.ts`
- [Submission endpoints](https://github.com/codebyartem/english-api/blob/main/src/assignments/submissions.controller.ts): `src/assignments/submissions.controller.ts`

### Identity and users

- [Authentication](https://github.com/codebyartem/english-api/blob/main/src/auth/auth.service.ts): `src/auth/auth.service.ts`
- [User management](https://github.com/codebyartem/english-api/blob/main/src/users/users.service.ts): `src/users/users.service.ts`
- [User account](https://github.com/codebyartem/english-api/blob/main/src/users/user.entity.ts): `src/users/user.entity.ts`
- [User roles](https://github.com/codebyartem/english-api/blob/main/src/common/role.enum.ts): `src/common/role.enum.ts`

### Learning content

- [Content access](https://github.com/codebyartem/english-api/blob/main/src/content/content.service.ts): `src/content/content.service.ts`
- [Content seeding](https://github.com/codebyartem/english-api/blob/main/src/content/seed.service.ts): `src/content/seed.service.ts`
- [Textbook](https://github.com/codebyartem/english-api/blob/main/src/content/entities/textbook.entity.ts): `src/content/entities/textbook.entity.ts`
- [Unit](https://github.com/codebyartem/english-api/blob/main/src/content/entities/unit.entity.ts): `src/content/entities/unit.entity.ts`
- [Lesson](https://github.com/codebyartem/english-api/blob/main/src/content/entities/lesson.entity.ts): `src/content/entities/lesson.entity.ts`
- [Exercise](https://github.com/codebyartem/english-api/blob/main/src/content/entities/exercise.entity.ts): `src/content/entities/exercise.entity.ts`
- [Material](https://github.com/codebyartem/english-api/blob/main/src/content/entities/material.entity.ts): `src/content/entities/material.entity.ts`

### Assignments

- [Assignment workflow](https://github.com/codebyartem/english-api/blob/main/src/assignments/assignments.service.ts): `src/assignments/assignments.service.ts`
- [Assignment record](https://github.com/codebyartem/english-api/blob/main/src/assignments/entities/assignment.entity.ts): `src/assignments/entities/assignment.entity.ts`
- [Submission record](https://github.com/codebyartem/english-api/blob/main/src/assignments/entities/submission.entity.ts): `src/assignments/entities/submission.entity.ts`

### Persistence

- **PostgreSQL**

### Other components

- **API client**

## Connections

- API client → Auth endpoints: requests (evidence: `src/auth/auth.controller.ts`)
- API client → Content endpoints: requests (evidence: `src/content/content.controller.ts`)
- API client → Assignment endpoints: requests (evidence: `src/assignments/assignments.controller.ts`)
- API client → Submission endpoints: requests (evidence: `src/assignments/submissions.controller.ts`)
- Auth endpoints → Authentication: delegates (evidence: `src/auth/auth.controller.ts`)
- Authentication → User management: looks up users (evidence: `src/auth/auth.service.ts`)
- User management → User account: creates and finds (evidence: `src/users/users.service.ts`)
- User account → User roles: uses role (evidence: `src/users/user.entity.ts`)
- Content endpoints → Content access: delegates (evidence: `src/content/content.controller.ts`)
- Nest application → Auth endpoints: registers module (evidence: `src/app.module.ts`)
- Nest application → Content endpoints: registers module (evidence: `src/app.module.ts`)
- Nest application → Assignment endpoints: registers module (evidence: `src/app.module.ts`)
- Nest application → Submission endpoints: registers module (evidence: `src/app.module.ts`)
- Assignment endpoints → Assignment workflow: delegates (evidence: `src/assignments/assignments.controller.ts`)
- Submission endpoints → Assignment workflow: delegates (evidence: `src/assignments/submissions.controller.ts`)
- Assignment workflow → Lesson: loads lesson exercises (evidence: `src/assignments/assignments.service.ts`)
- Textbook → Unit: has units (evidence: `src/content/entities/textbook.entity.ts`)
- Unit → Lesson: has lessons (evidence: `src/content/entities/unit.entity.ts`)
- Unit → Material: has materials (evidence: `src/content/entities/unit.entity.ts`)
- Lesson → Exercise: has exercises (evidence: `src/content/entities/lesson.entity.ts`)
- Assignment record → Lesson: references lesson (evidence: `src/assignments/entities/assignment.entity.ts`)
- Submission record → Assignment record: may reference (evidence: `src/assignments/entities/submission.entity.ts`)
- Submission record → Lesson: references lesson (evidence: `src/assignments/entities/submission.entity.ts`)
- Submission record → User account: belongs to student (evidence: `src/assignments/entities/submission.entity.ts`)
- Nest application → PostgreSQL: configures TypeORM (evidence: `src/app.module.ts`)
- User management → PostgreSQL: queries and saves (evidence: `src/users/users.service.ts`)
- Assignment workflow → PostgreSQL: queries and saves (evidence: `src/assignments/assignments.service.ts`)
- Content access → PostgreSQL: uses repositories (evidence: `src/content/content.service.ts`)
- Content seeding → Textbook: populates content (evidence: `src/content/seed.service.ts`)
- Content seeding → Unit: populates content (evidence: `src/content/seed.service.ts`)
- Content seeding → Lesson: populates content (evidence: `src/content/seed.service.ts`)
- Content seeding → Exercise: populates content (evidence: `src/content/seed.service.ts`)
- Content seeding → Material: populates content (evidence: `src/content/seed.service.ts`)
