# johngunji/software-component-catalogue architecture

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

- Interactive diagram: https://gitdiagram.com/johngunji/software-component-catalogue
- Repository: https://github.com/johngunji/software-component-catalogue

## Overview

ComponentHub is a web catalogue for reusable code and design components. Users sign in, then browse category trees, search and view components, and record reuse; cataloguers additionally manage catalogue content and inspect statistics and purge candidates. The browser UI uses a REST client to call the Express API, which owns authentication, validation, catalogue operations, search tracking, and statistics over SQLite. The graph covers documented API capabilities; some frontend page details are inferred from the README because their source was not sampled.

Main entry points: [`backend/src/server.js`](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js) (API routes and middleware), [`backend/src/db.js`](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/db.js) (Schema and credentials), [`frontend/js/catalogue.js`](https://github.com/johngunji/software-component-catalogue/blob/main/frontend/js/catalogue.js) (API client and session), [`frontend/js/login.js`](https://github.com/johngunji/software-component-catalogue/blob/main/frontend/js/login.js) (Sign-in page)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Browser application"]
  node_login_ui["Sign-in page<br/>[login.js]"]
  node_ui["Catalogue pages<br/>[app.js]"]
  node_client_data["API client and session<br/>[catalogue.js]"]
end

subgraph group_api["REST API"]
  node_api_server["API routes and middleware<br/>[server.js]"]
  node_auth["Authentication<br/>[server.js]"]
end

subgraph group_catalogue["Catalogue domain"]
  node_category_ops["Category management<br/>[server.js]"]
  node_component_ops["Component management<br/>[server.js]"]
  node_search["Search and query tracking<br/>[server.js]"]
  node_usage["Reuse tracking<br/>[server.js]"]
  node_statistics["Statistics and candidates<br/>[server.js]"]
end

subgraph group_persistence["Persistence and seed"]
  node_seed["Initial catalogue data<br/>[catalogue-seed.js]"]
  node_database_layer["Schema and credentials<br/>[db.js]"]
  node_sqlite[("SQLite catalogue store")]
end

node_visitor(("User"))
node_api_service{{"ComponentHub API"}}

node_visitor -->|"signs in"| node_login_ui
node_login_ui -->|"submits credentials"| node_client_data
node_client_data -->|"sends REST requests"| node_api_service
node_api_service -->|"routes requests"| node_api_server
node_ui -->|"uses catalogue client"| node_client_data
node_visitor -->|"browses and manages"| node_ui
node_api_server -->|"routes login and protects API"| node_auth
node_api_server -->|"handles category requests"| node_category_ops
node_api_server -->|"handles component requests"| node_component_ops
node_api_server -->|"handles search requests"| node_search
node_api_server -->|"handles use requests"| node_usage
node_api_server -->|"handles statistics requests"| node_statistics
node_api_server -->|"uses database module"| node_database_layer
node_database_layer -->|"reads and writes"| node_sqlite
node_database_layer -->|"seeds catalogue"| node_seed
node_category_ops -->|"reads and writes"| node_sqlite
node_component_ops -->|"reads and writes"| node_sqlite
node_search -->|"queries and logs searches"| node_sqlite
node_usage -->|"updates usage counts"| node_sqlite
node_statistics -->|"aggregates catalogue data"| node_sqlite
node_auth -->|"verifies account"| node_database_layer

click node_login_ui "https://github.com/johngunji/software-component-catalogue/blob/main/frontend/js/login.js"
click node_ui "https://github.com/johngunji/software-component-catalogue/blob/main/frontend/js/app.js"
click node_client_data "https://github.com/johngunji/software-component-catalogue/blob/main/frontend/js/catalogue.js"
click node_api_server "https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js"
click node_auth "https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js"
click node_category_ops "https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js"
click node_component_ops "https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js"
click node_search "https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js"
click node_usage "https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js"
click node_statistics "https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js"
click node_seed "https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/catalogue-seed.js"
click node_database_layer "https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/db.js"

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_login_ui,node_ui,node_client_data,node_visitor toneBlue
class node_api_server,node_auth toneAmber
class node_category_ops,node_component_ops,node_search,node_usage,node_statistics,node_api_service toneMint
class node_seed,node_database_layer,node_sqlite toneRose
```

## Components

### Browser application

- [Sign-in page](https://github.com/johngunji/software-component-catalogue/blob/main/frontend/js/login.js): `frontend/js/login.js`
- [Catalogue pages](https://github.com/johngunji/software-component-catalogue/blob/main/frontend/js/app.js): `frontend/js/app.js`
- [API client and session](https://github.com/johngunji/software-component-catalogue/blob/main/frontend/js/catalogue.js): `frontend/js/catalogue.js`

### REST API

- [API routes and middleware](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js): `backend/src/server.js`
- [Authentication](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js): `backend/src/server.js`

### Catalogue domain

- [Category management](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js): `backend/src/server.js`
- [Component management](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js): `backend/src/server.js`
- [Search and query tracking](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js): `backend/src/server.js`
- [Reuse tracking](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js): `backend/src/server.js`
- [Statistics and candidates](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/server.js): `backend/src/server.js`

### Persistence and seed

- [Initial catalogue data](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/catalogue-seed.js): `backend/src/catalogue-seed.js`
- [Schema and credentials](https://github.com/johngunji/software-component-catalogue/blob/main/backend/src/db.js): `backend/src/db.js`
- **SQLite catalogue store**

### Other components

- **User**
- **ComponentHub API**

## Connections

- User → Sign-in page: signs in (evidence: `README.md`)
- Sign-in page → API client and session: submits credentials (evidence: `frontend/js/login.js`)
- API client and session → ComponentHub API: sends REST requests (evidence: `frontend/js/catalogue.js`)
- ComponentHub API → API routes and middleware: routes requests (evidence: `README.md`)
- Catalogue pages → API client and session: uses catalogue client (evidence: `README.md`)
- User → Catalogue pages: browses and manages (evidence: `README.md`)
- API routes and middleware → Authentication: routes login and protects API (evidence: `backend/src/server.js`)
- API routes and middleware → Category management: handles category requests (evidence: `backend/src/server.js`)
- API routes and middleware → Component management: handles component requests (evidence: `backend/src/server.js`)
- API routes and middleware → Search and query tracking: handles search requests (evidence: `backend/src/server.js`)
- API routes and middleware → Reuse tracking: handles use requests (evidence: `backend/src/server.js`)
- API routes and middleware → Statistics and candidates: handles statistics requests (evidence: `backend/src/server.js`)
- API routes and middleware → Schema and credentials: uses database module (evidence: `backend/src/server.js`)
- Schema and credentials → SQLite catalogue store: reads and writes (evidence: `backend/src/db.js`)
- Schema and credentials → Initial catalogue data: seeds catalogue (evidence: `backend/src/db.js`)
- Category management → SQLite catalogue store: reads and writes (evidence: `backend/src/server.js`)
- Component management → SQLite catalogue store: reads and writes (evidence: `backend/src/server.js`)
- Search and query tracking → SQLite catalogue store: queries and logs searches (evidence: `backend/src/server.js`)
- Reuse tracking → SQLite catalogue store: updates usage counts (evidence: `backend/src/server.js`)
- Statistics and candidates → SQLite catalogue store: aggregates catalogue data (evidence: `backend/src/server.js`)
- Authentication → Schema and credentials: verifies account (evidence: `README.md`)
