Skip to content

code-map.md

Latest commit

 

History

History
119 lines (99 loc) · 6.94 KB

code-map.md

File metadata and controls

119 lines (99 loc) · 6.94 KB
Raw
type Reference
title Code Map
description Monorepo layout for Aspire orchestration, the SvelteKit frontend, and .NET backend projects.
tags
layout
resource HelpDesk.slnx

Code Map

Layout

HelpDesk/
├── frontend/
│   ├── src/lib/server/api/       # server-only typed backend clients and JWT cookie helper
│   ├── src/lib/api/generated/    # generated OpenAPI TypeScript declarations
│   ├── openapi/                  # committed backend API snapshots
│   └── scripts/openapi.mjs
├── backend/
│   ├── AppHost/                  # Aspire local full-stack orchestrator
│   ├── Deployment/               # production backend PID 1 launcher + volume seed
│   ├── Common/{StorageProvider,Tools}/
│   ├── Contracts/{UserIdentity,UserProfile,Notifications}/
│   └── Services/{UserIdentity,UserProfile,Notifications}/
├── compose.yaml                  # production Caddy edge and private service topology
├── Caddyfile                     # automatic HTTPS and BFF reverse proxy
├── deploy/helpdesk.service.in    # systemd unit template for Podman boot start
├── scripts/{deploy-init,deploy,install-host-service}.sh
├── {backend,frontend}/Dockerfile
├── .env.example                  # production variable template; no real secrets
├── DEPLOYMENT.md                 # VPS/Caddy/Podman host-service playbook
├── HelpDesk.slnx
├── package.json
└── pnpm-workspace.yaml

compose.yaml, root .env.example, root scripts/ (deploy tooling), Dockerfiles, and backend/Deployment/ are production-only artifacts. They do not replace Aspire local orchestration. Service-level Properties/launchSettings.json and frontend/.env.example remain removed/obsolete; the AppHost launch settings are active IDE configuration.

Orchestration

Path Contents
backend/AppHost/HelpDesk.AppHost.csproj Aspire 13.4.6 executable and resource package references
backend/AppHost/Program.cs Sole supported local full-stack graph: MongoDB, three services, Vite, references, waits, and injected API origins
backend/AppHost/Properties/launchSettings.json Rider/.NET HelpDesk.AppHost Development launch profile
package.json Root commands; stack:dev runs the AppHost

Backend modules

Path Contents
backend/Common/StorageProvider Mongo-backed remote event storage
backend/Common/Tools Generic helpers and permission group names
backend/Contracts/<Name> Service name, events, subscriber IDs as needed
backend/Services/<Name>/Program.cs Host, IPC/HTTP, DI, hubs, subscriptions
backend/Services/<Name>/Endpoints/ Service-owned REST endpoints
backend/Services/<Name>/Persistence/ Private entities, stores, database init
backend/Services/<Name>/Subscriptions/ Event handlers and colocated tests
backend/Services/<Name>/Tests/ Shared service test fixtures

Frontend modules

Path Contents
frontend/src/routes/ SvelteKit routes: landing (/), registration (/register), verify (/verify/[code]), login (/login), forgot password (/forgot-password), reset password (/reset-password/[code]), logout (/logout), profile (/settings/profile), picture proxy (/profile-pictures/**), shared shell layout
frontend/src/routes/+layout.server.ts Root layout load: session cookie → Profile GET /profiles/me for shell user chrome
frontend/src/routes/+layout.svelte Shared shell; signed-in account menu (Edit Profile, Log Out)
frontend/src/routes/register/ Registration form + server actions BFF to Identity register + resend-verification
frontend/src/routes/verify/[code]/ Email verification page; button posts to BFF action → Identity GET /identities/verify/{code}
frontend/src/routes/login/ Sign-in form + server actions BFF to Identity login + resend-verification; sets helpdesk_session cookie; optional safe redirectTo; not-verified recovery UI; Forgot password? → /forgot-password
frontend/src/routes/forgot-password/ Email-only request form; BFF ?/request → Identity forgot-password; opaque success card
frontend/src/routes/reset-password/[code]/ New password + confirm; BFF ?/reset → Identity reset-password; success CTA /login
frontend/src/routes/logout/ POST clears helpdesk_session and redirects /; GET redirects / without clear
frontend/src/routes/settings/profile/ Auth-gated profile view/edit BFF: load + update/upload/delete picture actions against Profile
frontend/src/routes/profile-pictures/[...path]/ Public BFF proxy to private Profile GET /profile-pictures/**; forwards range/cache headers and image metadata
frontend/src/app.css Global styles / Tailwind v4 entry; FE-Docs navy/cyan theme tokens (fe-*)
frontend/src/lib/server/api/ BFF-only config, clients, ApiError/problem mapping, session cookie, shared resend-verification and password-reset helpers
frontend/src/lib/resend-cooldown.ts Client-only 30m resend/reset cooldown: constant, m:ss formatter, register/login/forgot-password start + countdown visibility, button label/disable helpers
frontend/openapi/*.json Normalized Identity/Profile OpenAPI snapshots
frontend/src/lib/api/generated/*.d.ts Generated API path/schema types
frontend/scripts/openapi.mjs Snapshot/type workflow; live commands require explicit Aspire-derived URLs

Registration, email-verification, login, forgot/reset password, logout (shell menu → POST /logout), profile view/edit (including picture upload/delete), and signed-in shell chrome (name/avatar account menu) exist.

Entry points and endpoints

Resource Entry Local endpoint behavior
AppHost backend/AppHost/Program.cs Aspire dashboard and resource lifecycle
Frontend frontend/ Vite/SvelteKit Aspire-assigned during full-stack run; Playwright preview remains 4173
UserIdentity backend/Services/UserIdentity/Program.cs Aspire-assigned HTTP endpoint
UserProfile backend/Services/UserProfile/Program.cs Aspire-assigned HTTP endpoint
Notifications backend/Services/Notifications/Program.cs no public HTTP endpoint
MongoDB Aspire mongodb resource ephemeral authenticated standalone container

Read dynamic application endpoints from the Aspire dashboard. MongoDB uses fixed development port 27017 so direct test commands can share the Aspire-managed resource.

Sibling library sources

Outside this monorepo (paths relative to HelpDesk root):

Library Path
FastEndpoints ../FastEndpoints/
MongoDB.Entities ../MongoDB.Entities/

These are inspection sources, not in-solution project references.

Sources

  • package.json
  • frontend/package.json
  • frontend/src/
  • HelpDesk.slnx
  • backend/AppHost/
  • backend/Services/*/Program.cs
  • ../FastEndpoints/
  • ../MongoDB.Entities/