# baodam2001/algo-learn architecture

> Architecture diagram of the GitHub repository baodam2001/algo-learn, 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/baodam2001/algo-learn
- Repository: https://github.com/baodam2001/algo-learn

## Overview

algo-learn is an interactive learning platform for algorithms and data-structures courses. A learner selects a topic and question in the Svelte app; the shared question catalog and router identify a generator, which produces an exercise for the UI to display and interact with. The shared package also contains generators across logic, automata, graphs, mathematics, and core data structures, with reusable algorithm utilities. The graph uses documented imports for confirmed links; frontend routing and rendering links are dashed because the relevant route excerpts were not provided.

Main entry points: [`packages/shared/src/api/QuestionRouter.ts`](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/api/QuestionRouter.ts) (Question router), [`packages/shared/src/question-generators/propositional-logic/resolution.ts`](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/question-generators/propositional-logic/resolution.ts) (Resolution exercise), [`packages/settings/questionsSelection.stable.ts`](https://github.com/baodam2001/algo-learn/blob/main/packages/settings/questionsSelection.stable.ts) (Question selection), [`packages/shared/src/question-generators/automaton`](https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators/automaton) (Automata exercises)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experience["Learner experience"]
  node_web_routes["Web routes"]
  node_catalogue_ui["Question catalogue<br/>[Catalogue.svelte]"]
  node_question_view["Question view"]
  node_exercise_ui["Exercise interaction"]
end

subgraph group_question_runtime["Question runtime"]
  node_selection["Question selection"]
  node_router["Question router<br/>[QuestionRouter.ts]"]
  node_generator_contract["Question contracts"]
  node_parameters["Parameter handling<br/>[Parameters.ts]"]
end

subgraph group_generators["Question generators"]
  node_automata["Automata exercises"]
  node_automaton_generation["Automaton generation"]
  node_logic_exercises["Logic exercises"]
  node_resolution_exercise["Resolution exercise<br/>[resolution.ts]"]
  node_graph_exercises["Graph exercises"]
  node_data_structures["Data structures"]
  node_math_exercises["Math exercises"]
  node_other_exercises["Other exercises"]
end

subgraph group_shared_logic["Shared logic"]
  node_random["Seeded randomness<br/>[random.ts]"]
  node_graph_utils["Graph utilities<br/>[graph.ts]"]
  node_logic_utils["Propositional logic"]
  node_resolution_utils["Resolution utilities<br/>[resolution.ts]"]
  node_translations["Translations<br/>[translations.ts]"]
  node_format["Text formatting<br/>[format.ts]"]
  node_markdown["Markdown parsing<br/>[parseMarkdown.ts]"]
end

node_learner(("Learner"))

node_learner -.->|"opens"| node_web_routes
node_web_routes -.->|"shows catalogue"| node_catalogue_ui
node_catalogue_ui -.->|"selects question"| node_router
node_web_routes -.->|"loads collection"| node_selection
node_selection -->|"registers generators"| node_automata
node_selection -->|"registers generators"| node_logic_exercises
node_selection -->|"registers generators"| node_data_structures
node_router -->|"parses parameters"| node_parameters
node_router -->|"uses contract"| node_generator_contract
node_router -.->|"provides question"| node_question_view
node_question_view -.->|"renders exercise"| node_exercise_ui
node_automata -->|"uses generation"| node_automaton_generation
node_automata -->|"serializes link"| node_router
node_automata -->|"uses randomness"| node_random
node_resolution_exercise -->|"serializes link"| node_router
node_resolution_exercise -->|"uses literals"| node_logic_utils
node_resolution_exercise -->|"uses resolution"| node_resolution_utils
node_resolution_exercise -->|"uses randomness"| node_random
node_logic_utils -->|"builds rooted tree"| node_graph_utils
node_logic_utils -->|"uses markdown tools"| node_markdown
node_logic_utils -->|"uses resolution"| node_resolution_utils
node_translations -->|"formats text"| node_format
node_generator_contract -->|"types parameters"| node_parameters

click node_web_routes "https://github.com/baodam2001/algo-learn/tree/main/packages/svelte-front-end/src/routes"
click node_catalogue_ui "https://github.com/baodam2001/algo-learn/blob/main/packages/svelte-front-end/src/lib/components/catalogue/Catalogue.svelte"
click node_question_view "https://github.com/baodam2001/algo-learn/blob/main/packages/svelte-front-end/src/lib/components/ViewSingleQuestion.svelte"
click node_exercise_ui "https://github.com/baodam2001/algo-learn/blob/main/packages/svelte-front-end/src/lib/components/InteractWithQuestion.svelte"
click node_selection "https://github.com/baodam2001/algo-learn/blob/main/packages/settings/questionsSelection.stable.ts"
click node_router "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/api/QuestionRouter.ts"
click node_generator_contract "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/api/QuestionGenerator.ts"
click node_parameters "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/api/Parameters.ts"
click node_automata "https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators/automaton"
click node_automaton_generation "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/question-generators/automaton/generate/automatonGenerator.ts"
click node_logic_exercises "https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators/propositional-logic"
click node_resolution_exercise "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/question-generators/propositional-logic/resolution.ts"
click node_graph_exercises "https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators/graph-algorithms"
click node_data_structures "https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators"
click node_math_exercises "https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators/math"
click node_other_exercises "https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators"
click node_random "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/random.ts"
click node_graph_utils "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/graph.ts"
click node_logic_utils "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/propositionalLogic/propositionalLogic.ts"
click node_resolution_utils "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/propositionalLogic/resolution.ts"
click node_translations "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/translations.ts"
click node_format "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/format.ts"
click node_markdown "https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/parseMarkdown.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_web_routes,node_catalogue_ui,node_question_view,node_exercise_ui toneBlue
class node_selection,node_router,node_generator_contract,node_parameters toneAmber
class node_automata,node_automaton_generation,node_logic_exercises,node_resolution_exercise,node_graph_exercises,node_data_structures,node_math_exercises,node_other_exercises toneMint
class node_random,node_graph_utils,node_logic_utils,node_resolution_utils,node_translations,node_format,node_markdown toneRose
class node_learner toneIndigo
```

## Components

### Learner experience

- [Web routes](https://github.com/baodam2001/algo-learn/tree/main/packages/svelte-front-end/src/routes): `packages/svelte-front-end/src/routes`
- [Question catalogue](https://github.com/baodam2001/algo-learn/blob/main/packages/svelte-front-end/src/lib/components/catalogue/Catalogue.svelte): `packages/svelte-front-end/src/lib/components/catalogue/Catalogue.svelte`
- [Question view](https://github.com/baodam2001/algo-learn/blob/main/packages/svelte-front-end/src/lib/components/ViewSingleQuestion.svelte): `packages/svelte-front-end/src/lib/components/ViewSingleQuestion.svelte`
- [Exercise interaction](https://github.com/baodam2001/algo-learn/blob/main/packages/svelte-front-end/src/lib/components/InteractWithQuestion.svelte): `packages/svelte-front-end/src/lib/components/InteractWithQuestion.svelte`

### Question runtime

- [Question selection](https://github.com/baodam2001/algo-learn/blob/main/packages/settings/questionsSelection.stable.ts): `packages/settings/questionsSelection.stable.ts`
- [Question router](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/api/QuestionRouter.ts): `packages/shared/src/api/QuestionRouter.ts`
- [Question contracts](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/api/QuestionGenerator.ts): `packages/shared/src/api/QuestionGenerator.ts`
- [Parameter handling](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/api/Parameters.ts): `packages/shared/src/api/Parameters.ts`

### Question generators

- [Automata exercises](https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators/automaton): `packages/shared/src/question-generators/automaton`
- [Automaton generation](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/question-generators/automaton/generate/automatonGenerator.ts): `packages/shared/src/question-generators/automaton/generate/automatonGenerator.ts`
- [Logic exercises](https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators/propositional-logic): `packages/shared/src/question-generators/propositional-logic`
- [Resolution exercise](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/question-generators/propositional-logic/resolution.ts): `packages/shared/src/question-generators/propositional-logic/resolution.ts`
- [Graph exercises](https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators/graph-algorithms): `packages/shared/src/question-generators/graph-algorithms`
- [Data structures](https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators): `packages/shared/src/question-generators`
- [Math exercises](https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators/math): `packages/shared/src/question-generators/math`
- [Other exercises](https://github.com/baodam2001/algo-learn/tree/main/packages/shared/src/question-generators): `packages/shared/src/question-generators`

### Shared logic

- [Seeded randomness](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/random.ts): `packages/shared/src/utils/random.ts`
- [Graph utilities](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/graph.ts): `packages/shared/src/utils/graph.ts`
- [Propositional logic](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/propositionalLogic/propositionalLogic.ts): `packages/shared/src/utils/propositionalLogic/propositionalLogic.ts`
- [Resolution utilities](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/propositionalLogic/resolution.ts): `packages/shared/src/utils/propositionalLogic/resolution.ts`
- [Translations](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/translations.ts): `packages/shared/src/utils/translations.ts`
- [Text formatting](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/format.ts): `packages/shared/src/utils/format.ts`
- [Markdown parsing](https://github.com/baodam2001/algo-learn/blob/main/packages/shared/src/utils/parseMarkdown.ts): `packages/shared/src/utils/parseMarkdown.ts`

### Other components

- **Learner**

## Connections

- Learner → Web routes: opens
- Web routes → Question catalogue: shows catalogue
- Question catalogue → Question router: selects question
- Web routes → Question selection: loads collection
- Question selection → Automata exercises: registers generators (evidence: `packages/settings/questionsSelection.stable.ts`)
- Question selection → Logic exercises: registers generators (evidence: `packages/settings/questionsSelection.stable.ts`)
- Question selection → Data structures: registers generators (evidence: `packages/settings/questionsSelection.stable.ts`)
- Question router → Parameter handling: parses parameters (evidence: `packages/shared/src/api/QuestionRouter.ts`)
- Question router → Question contracts: uses contract (evidence: `packages/shared/src/api/QuestionRouter.ts`)
- Question router → Question view: provides question
- Question view → Exercise interaction: renders exercise
- Automata exercises → Automaton generation: uses generation (evidence: `packages/shared/src/question-generators/automaton/congruence.ts`)
- Automata exercises → Question router: serializes link (evidence: `packages/shared/src/question-generators/automaton/congruence.ts`)
- Automata exercises → Seeded randomness: uses randomness (evidence: `packages/shared/src/question-generators/automaton/congruence.ts`)
- Resolution exercise → Question router: serializes link (evidence: `packages/shared/src/question-generators/propositional-logic/resolution.ts`)
- Resolution exercise → Propositional logic: uses literals (evidence: `packages/shared/src/question-generators/propositional-logic/resolution.ts`)
- Resolution exercise → Resolution utilities: uses resolution (evidence: `packages/shared/src/question-generators/propositional-logic/resolution.ts`)
- Resolution exercise → Seeded randomness: uses randomness (evidence: `packages/shared/src/question-generators/propositional-logic/resolution.ts`)
- Propositional logic → Graph utilities: builds rooted tree (evidence: `packages/shared/src/utils/propositionalLogic/propositionalLogic.ts`)
- Propositional logic → Markdown parsing: uses markdown tools (evidence: `packages/shared/src/utils/propositionalLogic/propositionalLogic.ts`)
- Propositional logic → Resolution utilities: uses resolution (evidence: `packages/shared/src/utils/propositionalLogic/propositionalLogic.ts`)
- Translations → Text formatting: formats text (evidence: `packages/shared/src/utils/translations.ts`)
- Question contracts → Parameter handling: types parameters (evidence: `packages/shared/src/api/QuestionGenerator.ts`)
