Skip to the content.

Project Structure

Organization of the Nuxt application @tgmc/web (core/web).

Canonical documentation lives in the repo docs/ tree (not under core/web/docs/). In-app /docs reads that tree in place — see gallery-and-docs.md and shared/docs-source.ts.

Directory overview

core/web/
├── app/                      # Vue application (Nuxt 4 app/ dir)
│   ├── components/
│   ├── composables/
│   ├── layouts/
│   ├── pages/
│   ├── plugins/
│   ├── utils/
│   ├── app.vue
│   └── error.vue
├── assets/                   # CSS / static assets bundled by Vite
├── bin/                      # Dev helpers (SSL generation)
├── config-properties/        # Nuxt config delegates
├── content/                  # Nuxt Content collections (gallery JSON, etc.)
│                             # — do NOT put repo docs markdown here
├── content.config.ts         # Content collections; docs cwd = REPO_DOCS_DIR
├── layers/                   # Auto-scanned Nuxt layers (e.g. 1.base)
├── public/                   # Public static files
├── server/                   # Nitro API, middleware, DB adapters
├── services/                 # App services (storage shims, etc.)
├── shared/                   # Shared utilities (CDN, docs-source, syntax, …)
├── types/                    # TypeScript definitions / Nuxt augmentations
├── tests/                    # Vitest specs
├── examples/                 # Code examples
├── nuxt.config.ts
├── package.json
├── tsconfig*.json
└── vitest.config.ts

Workspace theme and libs sit outside this package: theme/core (@tgmc/theme), packages/*.

Key files

Configuration

Type system

Application code

Import aliases

Alias Path Usage
#shared ./shared Shared utilities
#types ./types Types (optional)
@tgmc/theme theme/core/dist Theme tokens
theme ../../theme/core Theme source alias

Full path map: typescript-config.md.

CDN structure

Nuxt layers

Marketing/blog pages stay under app/pages/. Admin token runtime config stays in the app root.

Workspace packages

Build with npm run build:libs or npm run build --workspace=@tgmc/<name>:

Package Docs / README
@tgmc/utilities packages/utilities.md
@tgmc/theme packages/theme.md
@tgmc/media-player packages/media-player/README.md
@tgmc/likwidlibs packages/likwidlibs/README.md
@tgmc/web-layer-admin Package README / layer notes above

Testing

Documentation structure

Location Role
docs/ (repo root) Canonical runbooks; in-app /docs source
docs/web/ App guides, features, setup, reference
docs/packages/theme.md Theme tokens, data-fit, ratios, container fit
core/web/content/ Content collections only — no docs markdown

Getting started

  1. Install (repo root): npm ci then npm run db:migrate:local
  2. Develop: npm run devhttp://localhost:4200
  3. Build: npm run build
  4. Test: npm test
  5. Preview built app: cd core/web && npm run preview (after a build)

See Quick Start.