# lissy93/personal-security-checklist architecture

> Architecture diagram of the GitHub repository lissy93/personal-security-checklist, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lissy93/personal-security-checklist
- Repository: https://github.com/lissy93/personal-security-checklist

## Overview

Personal Security Checklist is a security-guidance website with a companion data API and content-generation/validation utilities. Visitors browse checklist sections and articles, filter guidance, and track completion; API consumers can retrieve and search checklist data. The README documents the shared YAML content source and generated Markdown, but the YAML file is absent from this tree. Unsampled route wiring is therefore shown only where documented or directly evidenced by excerpts.

Main entry points: [`web/src/routes/article/index.tsx`](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/article/index.tsx) (Article Listing), [`web/src/routes/article/[slug]/index.tsx`](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/article/%5Bslug%5D/index.tsx) (Article Reader), [`lib/generate.py`](https://github.com/lissy93/personal-security-checklist/blob/master/lib/generate.py) (Markdown Generation), [`web/src/root.tsx`](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/root.tsx) (Qwik Site Root)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Checklist Website"]
  node_checklistbrowse["Checklist Browsing<br/>[index.tsx]"]
  node_checklistdetail["Checklist Sections<br/>[index.tsx]"]
  node_checklistview["Checklist Table"]
  node_progress["Progress Tracking<br/>[progress.tsx]"]
  node_sectionlinks["Section Navigation"]
  node_checkdata["Checklist Data<br/>[checklist.ts]"]
  node_checkstore["Checklist State"]
  node_localstore["Saved Progress"]
  node_articles["Article Listing<br/>[index.tsx]"]
  node_articlepage["Article Reader<br/>[index.tsx]"]
  node_articledata["Article Catalog<br/>[articles.ts]"]
  node_aboutpage["About Page<br/>[index.tsx]"]
end

subgraph group_content["Content Operations"]
  node_yamlcontent["Checklist Source"]
  node_validation["Content Validation<br/>[validate.py]"]
  node_generation["Markdown Generation<br/>[generate.py]"]
end

subgraph group_api["Checklist API"]
  node_api["Checklist API<br/>[api.py]"]
end

subgraph group_render["Web Rendering"]
  node_webroot["Qwik Site Root<br/>[root.tsx]"]
  node_ssr["SSR Renderer<br/>[entry.ssr.tsx]"]
  node_pagehead["Page Metadata<br/>[router-head.tsx]"]
end

node_visitor(("Checklist Visitor"))
node_apiuser(("API Consumer"))

node_visitor -->|"requests pages"| node_ssr
node_ssr -->|"renders"| node_webroot
node_webroot -->|"renders"| node_pagehead
node_visitor -->|"browses guidance"| node_checklistbrowse
node_visitor -->|"opens sections"| node_checklistdetail
node_visitor -->|"tracks completion"| node_progress
node_yamlcontent -->|"supplies content"| node_checkdata
node_yamlcontent -->|"referenced by"| node_api
node_yamlcontent -->|"feeds generation"| node_generation
node_generation -->|"produces checklist Markdown"| node_visitor
node_apiuser -->|"requests data"| node_api
node_visitor -->|"browses articles"| node_articles
node_articles -.->|"opens article"| node_articlepage
node_articlepage -->|"looks up article"| node_articledata
node_visitor -->|"views project details"| node_aboutpage

click node_webroot "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/root.tsx"
click node_ssr "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/entry.ssr.tsx"
click node_pagehead "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/components/router-head/router-head.tsx"
click node_checklistbrowse "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/checklist/index.tsx"
click node_checklistdetail "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/checklist/%5Btitle%5D/index.tsx"
click node_checklistview "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/components/psc/checklist-table.tsx"
click node_progress "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/components/psc/progress.tsx"
click node_sectionlinks "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/components/psc/section-link-grid.tsx"
click node_checkdata "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/data/checklist.ts"
click node_checkstore "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/store/checklist-context.ts"
click node_localstore "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/store/local-checklist-store.ts"
click node_articles "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/article/index.tsx"
click node_articlepage "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/article/%5Bslug%5D/index.tsx"
click node_articledata "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/data/articles.ts"
click node_aboutpage "https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/about/index.tsx"
click node_validation "https://github.com/lissy93/personal-security-checklist/blob/master/lib/validate.py"
click node_generation "https://github.com/lissy93/personal-security-checklist/blob/master/lib/generate.py"
click node_api "https://github.com/lissy93/personal-security-checklist/blob/master/lib/api.py"

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_checklistbrowse,node_checklistdetail,node_checklistview,node_progress,node_sectionlinks,node_checkdata,node_checkstore,node_localstore,node_articles,node_articlepage,node_articledata,node_aboutpage toneBlue
class node_yamlcontent,node_validation,node_generation toneAmber
class node_api,node_apiuser toneMint
class node_webroot,node_ssr,node_pagehead toneRose
class node_visitor toneIndigo
```

## Components

### Checklist Website

- [Checklist Browsing](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/checklist/index.tsx): `web/src/routes/checklist/index.tsx`
- [Checklist Sections](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/checklist/%5Btitle%5D/index.tsx): `web/src/routes/checklist/[title]/index.tsx`
- [Checklist Table](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/components/psc/checklist-table.tsx): `web/src/components/psc/checklist-table.tsx`
- [Progress Tracking](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/components/psc/progress.tsx): `web/src/components/psc/progress.tsx`
- [Section Navigation](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/components/psc/section-link-grid.tsx): `web/src/components/psc/section-link-grid.tsx`
- [Checklist Data](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/data/checklist.ts): `web/src/data/checklist.ts`
- [Checklist State](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/store/checklist-context.ts): `web/src/store/checklist-context.ts`
- [Saved Progress](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/store/local-checklist-store.ts): `web/src/store/local-checklist-store.ts`
- [Article Listing](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/article/index.tsx): `web/src/routes/article/index.tsx`
- [Article Reader](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/article/%5Bslug%5D/index.tsx): `web/src/routes/article/[slug]/index.tsx`
- [Article Catalog](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/data/articles.ts): `web/src/data/articles.ts`
- [About Page](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/routes/about/index.tsx): `web/src/routes/about/index.tsx`

### Content Operations

- **Checklist Source**
- [Content Validation](https://github.com/lissy93/personal-security-checklist/blob/master/lib/validate.py): `lib/validate.py`
- [Markdown Generation](https://github.com/lissy93/personal-security-checklist/blob/master/lib/generate.py): `lib/generate.py`

### Checklist API

- [Checklist API](https://github.com/lissy93/personal-security-checklist/blob/master/lib/api.py): `lib/api.py`

### Web Rendering

- [Qwik Site Root](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/root.tsx): `web/src/root.tsx`
- [SSR Renderer](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/entry.ssr.tsx): `web/src/entry.ssr.tsx`
- [Page Metadata](https://github.com/lissy93/personal-security-checklist/blob/master/web/src/components/router-head/router-head.tsx): `web/src/components/router-head/router-head.tsx`

### Other components

- **Checklist Visitor**
- **API Consumer**

## Connections

- Checklist Visitor → SSR Renderer: requests pages (evidence: `web/src/entry.ssr.tsx`)
- SSR Renderer → Qwik Site Root: renders (evidence: `web/src/entry.ssr.tsx`)
- Qwik Site Root → Page Metadata: renders (evidence: `web/src/root.tsx`)
- Checklist Visitor → Checklist Browsing: browses guidance
- Checklist Visitor → Checklist Sections: opens sections
- Checklist Visitor → Progress Tracking: tracks completion
- Checklist Source → Checklist Data: supplies content
- Checklist Source → Checklist API: referenced by
- Checklist Source → Markdown Generation: feeds generation
- Markdown Generation → Checklist Visitor: produces checklist Markdown
- API Consumer → Checklist API: requests data
- Checklist Visitor → Article Listing: browses articles
- Article Listing → Article Reader: opens article
- Article Reader → Article Catalog: looks up article (evidence: `web/src/routes/article/[slug]/index.tsx`)
- Checklist Visitor → About Page: views project details (evidence: `web/src/routes/about/index.tsx`)
