# sap-tutorials/tutorials-ims architecture

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

- Interactive diagram: https://gitdiagram.com/sap-tutorials/tutorials-ims
- Repository: https://github.com/sap-tutorials/tutorials-ims

## Overview

SAP Tutorial Platform hosts developer tutorials and community features, with a principal workflow from a visitor through the AppRouter and browser applications to CAP services and persisted HANA data. Authors and administrators also manage content and platform data through admin tools; tutorial publishing and rendering are documented as separate content stages. The graph retains major documented capabilities—search, progress, events, analytics, and QA previews—while source-level links are limited to relationships supported by the excerpts or README; several backend internals are not sampled.

Main entry points: [`srv/server.js`](https://github.com/sap-tutorials/tutorials-ims/blob/main/srv/server.js) (CAP services), [`approuter/server.js`](https://github.com/sap-tutorials/tutorials-ims/blob/main/approuter/server.js) (AppRouter), [`srv/search-service.js`](https://github.com/sap-tutorials/tutorials-ims/blob/main/srv/search-service.js) (Search service), [`hugo-apps/src`](https://github.com/sap-tutorials/tutorials-ims/tree/main/hugo-apps/src) (Tutorial site)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_edge["Access and delivery"]
  node_router["AppRouter<br/>[server.js]"]
end

subgraph group_experience["User experiences"]
  node_hugo["Tutorial site"]
  node_islands["Page applications"]
  node_admin["Admin shell and features"]
  node_analytics["Analytics Explorer<br/>[App.vue]"]
  node_display["Event display<br/>[App.vue]"]
  node_explore["Tutorial graph explorer<br/>[App.vue]"]
end

subgraph group_backend["Platform services"]
  node_cap["CAP services<br/>[server.js]"]
  node_search["Search service<br/>[search-service.js]"]
  node_semantic["Semantic search<br/>[semantic-search.js]"]
  node_kg["Knowledge graph search"]
  node_branch["Learning-path branching<br/>[engine.js]"]
  node_qa["QA preview service<br/>[server.js]"]
  node_embedding["Embedding pipeline"]
end

subgraph group_content["Content lifecycle"]
  node_publish["Content publishing<br/>[publish-content.ts]"]
  node_github["Tutorial repositories"]
  node_contentstore[("Tutorial content store<br/>[persistence.cds]")]
end

subgraph group_data["Persistence"]
  node_schema[("Platform data model<br/>[schema.cds]")]
end

node_visitor(("Visitor or author"))
node_hana[("SAP HANA Cloud")]

node_visitor -->|"requests pages"| node_router
node_router -->|"serves pages"| node_hugo
node_router -->|"proxies API"| node_cap
node_visitor -->|"administers platform"| node_admin
node_visitor -->|"explores analytics"| node_analytics
node_visitor -->|"monitors events"| node_display
node_visitor -->|"explores tutorials"| node_explore
node_visitor -->|"uses page features"| node_islands
node_admin -->|"uses services"| node_cap
node_analytics -->|"queries analytics"| node_cap
node_display -->|"receives event data"| node_cap
node_hugo -->|"loads tutorial pages"| node_contentstore
node_github -->|"provides markdown"| node_publish
node_publish -->|"publishes HTML"| node_contentstore
node_cap -->|"uses data model"| node_schema
node_schema -->|"persists data"| node_hana
node_cap -.->|"registers services"| node_search
node_search -->|"runs semantic search"| node_semantic
node_search -->|"computes KG signal"| node_kg
node_cap -.->|"evaluates learning paths"| node_branch
node_qa -->|"renders author previews"| node_visitor
node_embedding -.->|"stores embeddings"| node_hana

click node_router "https://github.com/sap-tutorials/tutorials-ims/blob/main/approuter/server.js"
click node_hugo "https://github.com/sap-tutorials/tutorials-ims/tree/main/hugo-apps/src"
click node_islands "https://github.com/sap-tutorials/tutorials-ims/tree/main/hugo-apps/src"
click node_admin "https://github.com/sap-tutorials/tutorials-ims/blob/main/app/admin-shell/webapp/controller/Shell.controller.js"
click node_analytics "https://github.com/sap-tutorials/tutorials-ims/blob/main/app/analytics-explorer/src/App.vue"
click node_display "https://github.com/sap-tutorials/tutorials-ims/blob/main/app/display-app/src/App.vue"
click node_explore "https://github.com/sap-tutorials/tutorials-ims/blob/main/app/explore/src/App.vue"
click node_cap "https://github.com/sap-tutorials/tutorials-ims/blob/main/srv/server.js"
click node_search "https://github.com/sap-tutorials/tutorials-ims/blob/main/srv/search-service.js"
click node_semantic "https://github.com/sap-tutorials/tutorials-ims/blob/main/srv/lib/semantic-search.js"
click node_kg "https://github.com/sap-tutorials/tutorials-ims/blob/main/packages/kg/search-kg-handler.js"
click node_branch "https://github.com/sap-tutorials/tutorials-ims/blob/main/srv/lib/branch/engine.js"
click node_qa "https://github.com/sap-tutorials/tutorials-ims/blob/main/srv-qa/server.js"
click node_publish "https://github.com/sap-tutorials/tutorials-ims/blob/main/scripts/publish-content.ts"
click node_contentstore "https://github.com/sap-tutorials/tutorials-ims/blob/main/db/persistence.cds"
click node_embedding "https://github.com/sap-tutorials/tutorials-ims/blob/main/packages/content/embedding-pipeline.js"
click node_schema "https://github.com/sap-tutorials/tutorials-ims/blob/main/db/schema.cds"

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_router toneBlue
class node_hugo,node_islands,node_admin,node_analytics,node_display,node_explore,node_hana toneAmber
class node_cap,node_search,node_semantic,node_kg,node_branch,node_qa,node_embedding toneMint
class node_publish,node_github,node_contentstore toneRose
class node_schema,node_visitor toneIndigo
```

## Components

### Access and delivery

- [AppRouter](https://github.com/sap-tutorials/tutorials-ims/blob/main/approuter/server.js): `approuter/server.js`

### User experiences

- [Tutorial site](https://github.com/sap-tutorials/tutorials-ims/tree/main/hugo-apps/src): `hugo-apps/src`
- [Page applications](https://github.com/sap-tutorials/tutorials-ims/tree/main/hugo-apps/src): `hugo-apps/src`
- [Admin shell and features](https://github.com/sap-tutorials/tutorials-ims/blob/main/app/admin-shell/webapp/controller/Shell.controller.js): `app/admin-shell/webapp/controller/Shell.controller.js`
- [Analytics Explorer](https://github.com/sap-tutorials/tutorials-ims/blob/main/app/analytics-explorer/src/App.vue): `app/analytics-explorer/src/App.vue`
- [Event display](https://github.com/sap-tutorials/tutorials-ims/blob/main/app/display-app/src/App.vue): `app/display-app/src/App.vue`
- [Tutorial graph explorer](https://github.com/sap-tutorials/tutorials-ims/blob/main/app/explore/src/App.vue): `app/explore/src/App.vue`

### Platform services

- [CAP services](https://github.com/sap-tutorials/tutorials-ims/blob/main/srv/server.js): `srv/server.js`
- [Search service](https://github.com/sap-tutorials/tutorials-ims/blob/main/srv/search-service.js): `srv/search-service.js`
- [Semantic search](https://github.com/sap-tutorials/tutorials-ims/blob/main/srv/lib/semantic-search.js): `srv/lib/semantic-search.js`
- [Knowledge graph search](https://github.com/sap-tutorials/tutorials-ims/blob/main/packages/kg/search-kg-handler.js): `packages/kg/search-kg-handler.js`
- [Learning-path branching](https://github.com/sap-tutorials/tutorials-ims/blob/main/srv/lib/branch/engine.js): `srv/lib/branch/engine.js`
- [QA preview service](https://github.com/sap-tutorials/tutorials-ims/blob/main/srv-qa/server.js): `srv-qa/server.js`
- [Embedding pipeline](https://github.com/sap-tutorials/tutorials-ims/blob/main/packages/content/embedding-pipeline.js): `packages/content/embedding-pipeline.js`

### Content lifecycle

- [Content publishing](https://github.com/sap-tutorials/tutorials-ims/blob/main/scripts/publish-content.ts): `scripts/publish-content.ts`
- **Tutorial repositories**
- [Tutorial content store](https://github.com/sap-tutorials/tutorials-ims/blob/main/db/persistence.cds): `db/persistence.cds`

### Persistence

- [Platform data model](https://github.com/sap-tutorials/tutorials-ims/blob/main/db/schema.cds): `db/schema.cds`

### Other components

- **Visitor or author**
- **SAP HANA Cloud**

## Connections

- Visitor or author → AppRouter: requests pages (evidence: `README.md`)
- AppRouter → Tutorial site: serves pages (evidence: `README.md`)
- AppRouter → CAP services: proxies API (evidence: `README.md`)
- Visitor or author → Admin shell and features: administers platform (evidence: `README.md`)
- Visitor or author → Analytics Explorer: explores analytics (evidence: `README.md`)
- Visitor or author → Event display: monitors events (evidence: `README.md`)
- Visitor or author → Tutorial graph explorer: explores tutorials (evidence: `README.md`)
- Visitor or author → Page applications: uses page features (evidence: `README.md`)
- Admin shell and features → CAP services: uses services (evidence: `README.md`)
- Analytics Explorer → CAP services: queries analytics (evidence: `README.md`)
- Event display → CAP services: receives event data (evidence: `README.md`)
- Tutorial site → Tutorial content store: loads tutorial pages (evidence: `README.md`)
- Tutorial repositories → Content publishing: provides markdown (evidence: `README.md`)
- Content publishing → Tutorial content store: publishes HTML (evidence: `README.md`)
- CAP services → Platform data model: uses data model (evidence: `README.md`)
- Platform data model → SAP HANA Cloud: persists data (evidence: `README.md`)
- CAP services → Search service: registers services
- Search service → Semantic search: runs semantic search (evidence: `srv/search-service.js`)
- Search service → Knowledge graph search: computes KG signal (evidence: `srv/search-service.js`)
- CAP services → Learning-path branching: evaluates learning paths
- QA preview service → Visitor or author: renders author previews (evidence: `README.md`)
- Embedding pipeline → SAP HANA Cloud: stores embeddings
