# vladislavsaltanov/quizforum architecture

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

- Interactive diagram: https://gitdiagram.com/vladislavsaltanov/quizforum
- Repository: https://github.com/vladislavsaltanov/quizforum

## Overview

QuizForum is a deadline-based public question bank: an author publishes a question with a hidden reference answer, users submit immutable attempts, and the deadline reveals answers and verdicts. The graph also preserves its separate comment moderation, trustee access, account lifecycle, leaderboard/profile, and external grading capabilities. The README documents several flows whose controller implementations were not sampled; those edges cite the README. Rails persistence is represented as a shared database, not as a guessed per-model call chain.

Main entry points: [`config/routes.rb`](https://github.com/vladislavsaltanov/quizforum/blob/main/config/routes.rb) (HTTP routes), [`app/controllers/questions_controller.rb`](https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/questions_controller.rb) (Question publishing), [`app/models/attempt.rb`](https://github.com/vladislavsaltanov/quizforum/blob/main/app/models/attempt.rb) (Attempt verdicts), [`app/models/user.rb`](https://github.com/vladislavsaltanov/quizforum/blob/main/app/models/user.rb) (User accounts)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_questions["Question lifecycle"]
  node_question_pages["Question publishing"]
  node_question_domain["Question rules<br/>[question.rb]"]
  node_attempt_submission["Attempt submission"]
  node_attempt_domain["Attempt verdicts<br/>[attempt.rb]"]
  node_question_store[("Question data<br/>[schema.rb]")]
end

subgraph group_evaluation["Review and discussion"]
  node_comment_flow["Comment moderation"]
  node_moderation_client["Moderation client"]
  node_jury_job["Jury grading job"]
  node_jury_client["Jury client<br/>[jury_client.rb]"]
  node_sidecar_api["Sidecar API<br/>[server.py]"]
  node_grader["Answer grader<br/>[grade.py]"]
  node_comment_domain["Comment visibility<br/>[comment.rb]"]
end

subgraph group_accounts["Accounts and rankings"]
  node_accounts_flow["Sign-in and confirmation"]
  node_registration_flow["Registration"]
  node_confirmation_flow["Email confirmation"]
  node_mail_delivery["Registration mail"]
  node_user_domain["User accounts<br/>[user.rb]"]
  node_profiles["Profiles"]
  node_leaderboard["Leaderboard"]
end

subgraph group_runtime["Rails and sidecar"]
  node_routes["HTTP routes<br/>[routes.rb]"]
  node_db[("PostgreSQL")]
end

node_user(("User"))
node_google["Google OAuth"]
node_email["Email service"]

node_user -->|"requests pages"| node_routes
node_routes -->|"routes question actions"| node_question_pages
node_routes -->|"routes attempts"| node_attempt_submission
node_routes -->|"routes comments"| node_comment_flow
node_routes -->|"routes sign-in"| node_accounts_flow
node_routes -->|"routes registration"| node_registration_flow
node_routes -->|"routes confirmation"| node_confirmation_flow
node_routes -->|"routes profile"| node_profiles
node_routes -->|"routes leaderboard"| node_leaderboard
node_question_pages -->|"checks and builds"| node_question_domain
node_question_pages -->|"checks question text"| node_moderation_client
node_question_pages -->|"saves questions"| node_question_store
node_question_pages -->|"reads attempts"| node_attempt_domain
node_question_pages -->|"reads visible comments"| node_comment_domain
node_user -->|"submits answer"| node_attempt_submission
node_attempt_submission -.->|"creates and updates verdict"| node_attempt_domain
node_attempt_submission -.->|"queues grading"| node_jury_job
node_jury_job -.->|"requests grade"| node_jury_client
node_jury_client -.->|"posts answer"| node_sidecar_api
node_sidecar_api -->|"grades answer"| node_grader
node_user -->|"posts comment"| node_comment_flow
node_comment_flow -->|"checks comment"| node_moderation_client
node_comment_flow -->|"saves and approves"| node_comment_domain
node_moderation_client -->|"posts text"| node_sidecar_api
node_sidecar_api -.->|"returns moderation result"| node_question_pages
node_registration_flow -.->|"creates account"| node_user_domain
node_accounts_flow -->|"authenticates account"| node_user_domain
node_accounts_flow -->|"uses OAuth"| node_google
node_confirmation_flow -.->|"confirms account"| node_user_domain
node_registration_flow -.->|"sends confirmation"| node_mail_delivery
node_mail_delivery -->|"delivers email"| node_email
node_profiles -->|"reads and updates"| node_user_domain
node_profiles -->|"calculates rank"| node_attempt_domain
node_leaderboard -->|"ranks verdicts"| node_attempt_domain
node_question_store -.->|"persists records"| node_db
node_question_domain -.->|"persists questions"| node_db
node_attempt_domain -.->|"persists attempts"| node_db
node_comment_domain -.->|"persists comments"| node_db
node_user_domain -.->|"persists users"| node_db

click node_routes "https://github.com/vladislavsaltanov/quizforum/blob/main/config/routes.rb"
click node_question_pages "https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/questions_controller.rb"
click node_question_domain "https://github.com/vladislavsaltanov/quizforum/blob/main/app/models/question.rb"
click node_attempt_submission "https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/attempts_controller.rb"
click node_attempt_domain "https://github.com/vladislavsaltanov/quizforum/blob/main/app/models/attempt.rb"
click node_question_store "https://github.com/vladislavsaltanov/quizforum/blob/main/db/schema.rb"
click node_comment_flow "https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/comments_controller.rb"
click node_moderation_client "https://github.com/vladislavsaltanov/quizforum/blob/main/app/services/moderation_client.rb"
click node_jury_job "https://github.com/vladislavsaltanov/quizforum/blob/main/app/jobs/attempt_jury_job.rb"
click node_jury_client "https://github.com/vladislavsaltanov/quizforum/blob/main/app/services/jury_client.rb"
click node_sidecar_api "https://github.com/vladislavsaltanov/quizforum/blob/main/sidecar/server.py"
click node_grader "https://github.com/vladislavsaltanov/quizforum/blob/main/sidecar/grade.py"
click node_comment_domain "https://github.com/vladislavsaltanov/quizforum/blob/main/app/models/comment.rb"
click node_accounts_flow "https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/sessions_controller.rb"
click node_registration_flow "https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/registrations_controller.rb"
click node_confirmation_flow "https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/confirmations_controller.rb"
click node_mail_delivery "https://github.com/vladislavsaltanov/quizforum/blob/main/app/mailers/registration_mailer.rb"
click node_user_domain "https://github.com/vladislavsaltanov/quizforum/blob/main/app/models/user.rb"
click node_profiles "https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/profiles_controller.rb"
click node_leaderboard "https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/leaderboards_controller.rb"

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_question_pages,node_question_domain,node_attempt_submission,node_attempt_domain,node_question_store,node_user toneBlue
class node_comment_flow,node_moderation_client,node_jury_job,node_jury_client,node_sidecar_api,node_grader,node_comment_domain toneAmber
class node_accounts_flow,node_registration_flow,node_confirmation_flow,node_mail_delivery,node_user_domain,node_profiles,node_leaderboard toneMint
class node_routes,node_db toneRose
class node_google,node_email toneIndigo
```

## Components

### Question lifecycle

- [Question publishing](https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/questions_controller.rb): `app/controllers/questions_controller.rb`
- [Question rules](https://github.com/vladislavsaltanov/quizforum/blob/main/app/models/question.rb): `app/models/question.rb`
- [Attempt submission](https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/attempts_controller.rb): `app/controllers/attempts_controller.rb`
- [Attempt verdicts](https://github.com/vladislavsaltanov/quizforum/blob/main/app/models/attempt.rb): `app/models/attempt.rb`
- [Question data](https://github.com/vladislavsaltanov/quizforum/blob/main/db/schema.rb): `db/schema.rb`

### Review and discussion

- [Comment moderation](https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/comments_controller.rb): `app/controllers/comments_controller.rb`
- [Moderation client](https://github.com/vladislavsaltanov/quizforum/blob/main/app/services/moderation_client.rb): `app/services/moderation_client.rb`
- [Jury grading job](https://github.com/vladislavsaltanov/quizforum/blob/main/app/jobs/attempt_jury_job.rb): `app/jobs/attempt_jury_job.rb`
- [Jury client](https://github.com/vladislavsaltanov/quizforum/blob/main/app/services/jury_client.rb): `app/services/jury_client.rb`
- [Sidecar API](https://github.com/vladislavsaltanov/quizforum/blob/main/sidecar/server.py): `sidecar/server.py`
- [Answer grader](https://github.com/vladislavsaltanov/quizforum/blob/main/sidecar/grade.py): `sidecar/grade.py`
- [Comment visibility](https://github.com/vladislavsaltanov/quizforum/blob/main/app/models/comment.rb): `app/models/comment.rb`

### Accounts and rankings

- [Sign-in and confirmation](https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/sessions_controller.rb): `app/controllers/sessions_controller.rb`
- [Registration](https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/registrations_controller.rb): `app/controllers/registrations_controller.rb`
- [Email confirmation](https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/confirmations_controller.rb): `app/controllers/confirmations_controller.rb`
- [Registration mail](https://github.com/vladislavsaltanov/quizforum/blob/main/app/mailers/registration_mailer.rb): `app/mailers/registration_mailer.rb`
- [User accounts](https://github.com/vladislavsaltanov/quizforum/blob/main/app/models/user.rb): `app/models/user.rb`
- [Profiles](https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/profiles_controller.rb): `app/controllers/profiles_controller.rb`
- [Leaderboard](https://github.com/vladislavsaltanov/quizforum/blob/main/app/controllers/leaderboards_controller.rb): `app/controllers/leaderboards_controller.rb`

### Rails and sidecar

- [HTTP routes](https://github.com/vladislavsaltanov/quizforum/blob/main/config/routes.rb): `config/routes.rb`
- **PostgreSQL**

### Other components

- **User**
- **Google OAuth**
- **Email service**

## Connections

- User → HTTP routes: requests pages (evidence: `config/routes.rb`)
- HTTP routes → Question publishing: routes question actions (evidence: `config/routes.rb`)
- HTTP routes → Attempt submission: routes attempts (evidence: `config/routes.rb`)
- HTTP routes → Comment moderation: routes comments (evidence: `config/routes.rb`)
- HTTP routes → Sign-in and confirmation: routes sign-in (evidence: `config/routes.rb`)
- HTTP routes → Registration: routes registration (evidence: `config/routes.rb`)
- HTTP routes → Email confirmation: routes confirmation (evidence: `config/routes.rb`)
- HTTP routes → Profiles: routes profile (evidence: `config/routes.rb`)
- HTTP routes → Leaderboard: routes leaderboard (evidence: `config/routes.rb`)
- Question publishing → Question rules: checks and builds (evidence: `app/controllers/questions_controller.rb`)
- Question publishing → Moderation client: checks question text (evidence: `app/controllers/questions_controller.rb`)
- Question publishing → Question data: saves questions (evidence: `app/controllers/questions_controller.rb`)
- Question publishing → Attempt verdicts: reads attempts (evidence: `app/controllers/questions_controller.rb`)
- Question publishing → Comment visibility: reads visible comments (evidence: `app/controllers/questions_controller.rb`)
- User → Attempt submission: submits answer (evidence: `README.md`)
- Attempt submission → Attempt verdicts: creates and updates verdict
- Attempt submission → Jury grading job: queues grading
- Jury grading job → Jury client: requests grade
- Jury client → Sidecar API: posts answer
- Sidecar API → Answer grader: grades answer (evidence: `sidecar/server.py`)
- User → Comment moderation: posts comment (evidence: `README.md`)
- Comment moderation → Moderation client: checks comment (evidence: `app/controllers/comments_controller.rb`)
- Comment moderation → Comment visibility: saves and approves (evidence: `app/controllers/comments_controller.rb`)
- Moderation client → Sidecar API: posts text (evidence: `app/services/moderation_client.rb`)
- Sidecar API → Question publishing: returns moderation result
- Registration → User accounts: creates account
- Sign-in and confirmation → User accounts: authenticates account (evidence: `app/controllers/sessions_controller.rb`)
- Sign-in and confirmation → Google OAuth: uses OAuth (evidence: `README.md`)
- Email confirmation → User accounts: confirms account
- Registration → Registration mail: sends confirmation
- Registration mail → Email service: delivers email (evidence: `README.md`)
- Profiles → User accounts: reads and updates (evidence: `app/controllers/profiles_controller.rb`)
- Profiles → Attempt verdicts: calculates rank (evidence: `app/controllers/profiles_controller.rb`)
- Leaderboard → Attempt verdicts: ranks verdicts (evidence: `README.md`)
- Question data → PostgreSQL: persists records
- Question rules → PostgreSQL: persists questions
- Attempt verdicts → PostgreSQL: persists attempts
- Comment visibility → PostgreSQL: persists comments
- User accounts → PostgreSQL: persists users
