# maurodesouza/profile-readme-generator architecture

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

- Interactive diagram: https://gitdiagram.com/maurodesouza/profile-readme-generator
- Repository: https://github.com/maurodesouza/profile-readme-generator

## Overview

Profile README Generator is a localized web app for assembling a customized GitHub profile README. The central workflow is to configure and arrange profile sections on the canvas, generate a README preview/result, and optionally import an existing generated README back into editable sections. The tree also shows section-specific capabilities for stats, socials, techs, music, activities, images, borders, and contribution games. Relationship evidence is limited to the README and indexed excerpts; unshown runtime wiring is omitted.

Main entry points: [`src/app/[locale]/layout.tsx`](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/app/%5Blocale%5D/layout.tsx) (Localized app), [`src/components/handles/canvas/index.tsx`](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/handles/canvas/index.tsx) (Canvas commands), [`src/app/[locale]/page.tsx`](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/app/%5Blocale%5D/page.tsx) (Canvas page), [`src/components/templates/canvas/index.tsx`](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/templates/canvas/index.tsx) (Canvas template)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experience["App experience"]
  node_localized_app["Localized app<br/>[layout.tsx]"]
  node_canvas_page["Canvas page<br/>[page.tsx]"]
  node_result_page["Result page<br/>[page.tsx]"]
end

subgraph group_editor["README editor"]
  node_canvas_ui["Canvas UI<br/>[index.tsx]"]
  node_panel_ui["Editor panels<br/>[index.tsx]"]
  node_panel_registry["Panel registry<br/>[panels.ts]"]
  node_result_view["README result<br/>[index.tsx]"]
  node_canvas_template["Canvas template<br/>[index.tsx]"]
  node_result_template["Result template<br/>[index.tsx]"]
end

subgraph group_features["Profile sections"]
  node_feature_catalog["Section catalog<br/>[index.tsx]"]
  node_section_features["Section features"]
end

subgraph group_runtime["Editor runtime"]
  node_readme_import["README importer<br/>[index.ts]"]
  node_section_importers["Section importers"]
  node_section_parsers["Section parsers"]
  node_url_builders["Image URL builders<br/>[index.ts]"]
  node_canvas_handle["Canvas commands<br/>[index.tsx]"]
  node_canvas_store["Canvas state<br/>[index.ts]"]
  node_command_bus["Command bus<br/>[command-bus.ts]"]
  node_settings_handle["Settings handle<br/>[index.tsx]"]
end

node_user(("README author"))

node_user -.->|"opens editor"| node_canvas_page
node_localized_app -->|"hosts route"| node_canvas_page
node_localized_app -->|"renders"| node_feature_catalog
node_localized_app -.->|"registers handlers"| node_canvas_handle
node_canvas_page -.->|"renders"| node_canvas_template
node_canvas_template -.->|"renders"| node_canvas_ui
node_canvas_template -.->|"renders"| node_panel_ui
node_panel_ui -->|"reads panels"| node_panel_registry
node_panel_registry -->|"registers panels"| node_section_features
node_feature_catalog -->|"loads features"| node_section_features
node_canvas_handle -->|"registers commands"| node_command_bus
node_canvas_handle -->|"updates state"| node_canvas_store
node_canvas_handle -->|"parses imported file"| node_readme_import
node_readme_import -->|"dispatches imports"| node_section_importers
node_section_features -.->|"parses sections"| node_section_parsers
node_section_parsers -->|"builds image URLs"| node_url_builders
node_canvas_page -.->|"opens result"| node_result_page
node_result_page -.->|"renders"| node_result_template
node_result_template -.->|"renders"| node_result_view
node_localized_app -.->|"registers handles"| node_settings_handle

click node_localized_app "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/app/%5Blocale%5D/layout.tsx"
click node_canvas_page "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/app/%5Blocale%5D/page.tsx"
click node_result_page "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/app/%5Blocale%5D/result/page.tsx"
click node_canvas_ui "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/organisms/canvas/index.tsx"
click node_panel_ui "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/organisms/panel/index.tsx"
click node_panel_registry "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/organisms/panels/panels.ts"
click node_result_view "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/organisms/readme-result/index.tsx"
click node_canvas_template "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/templates/canvas/index.tsx"
click node_result_template "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/templates/result/index.tsx"
click node_feature_catalog "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/features/index.tsx"
click node_section_features "https://github.com/maurodesouza/profile-readme-generator/tree/main/src/features"
click node_readme_import "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/utils/parsers/from-readme/index.ts"
click node_section_importers "https://github.com/maurodesouza/profile-readme-generator/tree/main/src/features"
click node_section_parsers "https://github.com/maurodesouza/profile-readme-generator/tree/main/src/features"
click node_url_builders "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/utils/url/index.ts"
click node_canvas_handle "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/handles/canvas/index.tsx"
click node_canvas_store "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/stores/canvas-store/index.ts"
click node_command_bus "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/lib/command/command-bus.ts"
click node_settings_handle "https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/handles/settings/index.tsx"

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_localized_app,node_canvas_page,node_result_page toneBlue
class node_canvas_ui,node_panel_ui,node_panel_registry,node_result_view,node_canvas_template,node_result_template toneAmber
class node_feature_catalog,node_section_features toneMint
class node_readme_import,node_section_importers,node_section_parsers,node_url_builders,node_canvas_handle,node_canvas_store,node_command_bus,node_settings_handle toneRose
class node_user toneIndigo
```

## Components

### App experience

- [Localized app](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/app/%5Blocale%5D/layout.tsx): `src/app/[locale]/layout.tsx`
- [Canvas page](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/app/%5Blocale%5D/page.tsx): `src/app/[locale]/page.tsx`
- [Result page](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/app/%5Blocale%5D/result/page.tsx): `src/app/[locale]/result/page.tsx`

### README editor

- [Canvas UI](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/organisms/canvas/index.tsx): `src/components/organisms/canvas/index.tsx`
- [Editor panels](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/organisms/panel/index.tsx): `src/components/organisms/panel/index.tsx`
- [Panel registry](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/organisms/panels/panels.ts): `src/components/organisms/panels/panels.ts`
- [README result](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/organisms/readme-result/index.tsx): `src/components/organisms/readme-result/index.tsx`
- [Canvas template](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/templates/canvas/index.tsx): `src/components/templates/canvas/index.tsx`
- [Result template](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/templates/result/index.tsx): `src/components/templates/result/index.tsx`

### Profile sections

- [Section catalog](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/features/index.tsx): `src/features/index.tsx`
- [Section features](https://github.com/maurodesouza/profile-readme-generator/tree/main/src/features): `src/features`

### Editor runtime

- [README importer](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/utils/parsers/from-readme/index.ts): `src/utils/parsers/from-readme/index.ts`
- [Section importers](https://github.com/maurodesouza/profile-readme-generator/tree/main/src/features): `src/features`
- [Section parsers](https://github.com/maurodesouza/profile-readme-generator/tree/main/src/features): `src/features`
- [Image URL builders](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/utils/url/index.ts): `src/utils/url/index.ts`
- [Canvas commands](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/handles/canvas/index.tsx): `src/components/handles/canvas/index.tsx`
- [Canvas state](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/stores/canvas-store/index.ts): `src/stores/canvas-store/index.ts`
- [Command bus](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/lib/command/command-bus.ts): `src/lib/command/command-bus.ts`
- [Settings handle](https://github.com/maurodesouza/profile-readme-generator/blob/main/src/components/handles/settings/index.tsx): `src/components/handles/settings/index.tsx`

### Other components

- **README author**

## Connections

- README author → Canvas page: opens editor (evidence: `README.md`)
- Localized app → Canvas page: hosts route (evidence: `src/app/[locale]/layout.tsx`)
- Localized app → Section catalog: renders (evidence: `src/app/[locale]/layout.tsx`)
- Localized app → Canvas commands: registers handlers (evidence: `src/app/[locale]/layout.tsx`)
- Canvas page → Canvas template: renders
- Canvas template → Canvas UI: renders
- Canvas template → Editor panels: renders
- Editor panels → Panel registry: reads panels (evidence: `src/components/organisms/panel/index.tsx`)
- Panel registry → Section features: registers panels (evidence: `src/components/organisms/panels/panels.ts`)
- Section catalog → Section features: loads features (evidence: `src/app/[locale]/layout.tsx`)
- Canvas commands → Command bus: registers commands (evidence: `src/components/handles/canvas/index.tsx`)
- Canvas commands → Canvas state: updates state (evidence: `src/components/handles/canvas/index.tsx`)
- Canvas commands → README importer: parses imported file (evidence: `src/components/handles/canvas/index.tsx`)
- README importer → Section importers: dispatches imports (evidence: `src/utils/parsers/from-readme/index.ts`)
- Section features → Section parsers: parses sections
- Section parsers → Image URL builders: builds image URLs (evidence: `src/features/activities/parser.ts`)
- Canvas page → Result page: opens result (evidence: `README.md`)
- Result page → Result template: renders
- Result template → README result: renders
- Localized app → Settings handle: registers handles
