d03ef2db50
Classified every TODO.md item into one of DONE/BACKEND/PRODUCT DECISION/FUTURE VERSION/BUG, verified against source, not against prior docs: - BACKEND items (bootstrap content, builder draft/publish, 6 admin CRUD domains, media pipeline) confirmed already covered by BACKEND_INTEGRATION.md; appended a mapping appendix rather than duplicating raw bullets. Fixed 22 stale internal BACKEND_API.md cross-references left over from before that file was archived. - PRODUCT DECISION items (dark mode, brand-color WCAG contrast, stars.component token gap, footer Contacts content, advanced analytics, payment providers) moved to new docs/PRODUCT_BACKLOG.md. - FUTURE VERSION items (Angular 22, bundle splitting, cart-modal composition cleanup, hero-spacing investigation) moved to new docs/FUTURE_FEATURES.md. - BUG: rewrote docs/KNOWN-ISSUES.md down to the one real, verified, currently-reproducible frontend bug (Ed25519 admin-auth error codes session-expired/invalid-signature are unreachable - toAuthErrorShape() never reads a body error code, only maps HTTP status, and no status ever produces those two codes - confirmed by reading auth.service.ts + auth-error.model.ts). Condensed the "Fixed" history instead of carrying full verbose repro text forward. - DONE items removed outright (dead-code deletion, dashboard false positive, RC-02 fixes, stale "dynamic-renderer unwired"/"178 missing keys" claims already disproven by source). docs/TODO.md rewritten to the exact "no blockers" template - nothing left qualifies as a release blocker. New docs/PROJECT_STATUS.md: honest per-area status (frontend/backend/ docs/auth/builder/storefront/admin), known limitations, and explicit production/backend/demo readiness calls - including correcting an initial draft's unpushed-commit count (53, not 10, per git log origin/B2B..HEAD). New docs/NEXT_PHASE.md: work that can only start once a real backend exists (gateway swap-in, mock removal, dormant-auth activation, role enforcement, integration/E2E tests, perf profiling, monitoring, maintenance-mode UI). docs/PROJECT_INDEX.md (the stated entry point) updated to link the new doc set and stop pointing at the now-archived BACKEND_API.md/AUTH.md. docs/FRONTEND-ROADMAP.md's "Known open items" replaced with pointers to the new category-split docs instead of a duplicated mixed list. Not swept: a handful of low-traffic docs (architecture ADRs, FRONTEND.md, EDITOR.md, ARCHITECTURE.md, PROJECT-STRUCTURE.md, StaticPages.md, ADMIN.md) still reference the old BACKEND_API.md/ AUTH.md filenames - noted as a known gap in PROJECT_STATUS.md rather than touched blindly, since they're historical-context docs, not the navigation entry point.
8.0 KiB
8.0 KiB
Marketplace Platform — Documentation Index
This is the entry point. Read this first — it links to everything else and tells you what's actually true right now versus what's historical.
What this is
A configuration-driven, multi-tenant SaaS marketplace platform (Angular 21.1, standalone components). One frontend codebase serves unlimited tenants ("marketplaces"). Tenant identity, theme, navigation, page/section/widget composition, and static content all resolve from a per-tenant bootstrap.json fetched at runtime — no tenant-specific code paths exist in the frontend. New tenants are onboarded by domain + config + backend data, never by forking the frontend.
Every tenant has three surfaces on this one codebase:
- Website — the public storefront (catalog, product pages, cart, static pages).
- Builder (Project Editor,
/edit/**) — an in-app editor that edits the tenant'sBootstrapConfig. - Backoffice (Admin,
/:lang/backoffice/**) — the admin area: products, categories (live-wired to a real gateway), orders, transactions, users, monitoring, analytics, media.
System overview
- Architecture:
Component (container) → Facade → Domain Service → Repository/Provider (DI token, swappable mock↔API) → Mock | API. Enforced bynpm run arch:check(import boundaries + circular deps), not just convention. Full detail: ARCHITECTURE.md, governance docs atdocs/architecture/foundation/**(10 ADRs + 9 standards docs). - State: Signals-based facades everywhere, no NgRx (ADR-007).
- Rendering: Bootstrap JSON → Section Engine → Page Renderer → Widget Host → registered widget component (ADR-005). 100% lazy-loaded routes.
- Theming: CSS custom properties per tenant, 3 theme stylesheets, never hardcoded hex in a component (ADR-008). Design system spec:
DESIGN.md(root of repo). - i18n: 3 locales (en/ru/hy), compile-time-enforced key parity across locale files.
- Backend: mostly PLANNED (mock gateways behind swappable provider tokens) — see BACKEND_INTEGRATION.md, the single canonical backend spec (endpoints, DTOs, auth, security, error model, uploads, migration guide, checklist). Categories is the one domain fully wired to a real HTTP gateway; everything else is local/mock.
Doc index (living documents)
Read these directly — they're the current source of truth, not one-off reports:
| Doc | What it covers |
|---|---|
| ARCHITECTURE.md | Layered architecture, container/facade/service pattern, bootstrap/theme/widget engines, links to the enforced ADRs |
| BACKEND_INTEGRATION.md | Canonical backend spec — every endpoint, DTO, CRUD contract, auth, security, error model, uploads, migration guide, checklist |
| AUTHENTICATION.md | Standalone auth deep-dive (also inlined in BACKEND_INTEGRATION.md §4) |
| ERROR_CONTRACT.md | Standalone error-contract deep-dive (also inlined in BACKEND_INTEGRATION.md §6) |
| MAINTENANCE_MODE.md | Global/tenant/module maintenance-mode contract |
| FRONTEND.md | App structure, routing, i18n, theming, state management, dynamic rendering |
| EDITOR.md | The Project Editor: every section, save/publish/draft/reset model |
| StaticPages.md | The Static Pages CMS module (the thing that actually serves About/Contacts/etc. today) |
| PROJECT-STRUCTURE.md | Folder-by-folder tour of src/app/** with a worked feature-add example |
| ADMIN.md | Admin backoffice: routing, architecture, data sources |
| PROJECT_STATUS.md | Final Release Candidate status — frontend/backend/docs/auth/builder/storefront/admin readiness, honest limitations |
| FRONTEND-ROADMAP.md | Status snapshot refreshed from recent commits — what shipped, what's open |
| KNOWN-ISSUES.md | Real, reproducible, currently-open frontend bugs only |
| PRODUCT_BACKLOG.md | Items needing a client/business decision (dark mode, brand colors, page content, etc.) |
| FUTURE_FEATURES.md | Nice-to-have, non-blocking future work (Angular 22, bundle splitting, etc.) |
| NEXT_PHASE.md | What happens after backend integration lands |
| TODO.md | Release blockers only — currently empty |
| ANGULAR22_PLAN.md | Angular 22 upgrade feasibility (research only, not yet executed) |
| SALES-GUIDE.md | Plain-language guide for the sales team — what to demo, what's not live yet |
../DESIGN.md |
Visual design system: colors, typography, elevation, component specs |
../PRODUCT.md |
Product positioning, users, brand personality, anti-references |
../CHANGELOG.md |
Keep-a-Changelog-format history of shipped features |
docs/architecture/foundation/** |
Enforced ADRs (ADR-001…ADR-010) and standards docs — governance, read directly |
docs/context/** |
Barry Cache's own source-backed memory system — infrastructure, not project documentation, do not edit by hand |
docs/archive/** |
Superseded docs, kept for history only — do not implement against these |
One topic, one place: routing lives in FRONTEND.md, not repeated here. Backend contract lives in BACKEND_INTEGRATION.md, not repeated in ADMIN.md. Design tokens live in DESIGN.md, not repeated elsewhere.
What's still open
TODO.md — release blockers only. PRODUCT_BACKLOG.md and FUTURE_FEATURES.md hold everything else that isn't a blocker.
Historical reports
19 one-off audit/sprint/review reports were archived, then deleted once every open finding worth keeping was confirmed merged into KNOWN-ISSUES.md/FRONTEND-ROADMAP.md/TODO.md. Full original text recoverable via git log --diff-filter=D -- docs/archive if needed.
How to run it
npm install
npm run start # ng serve
npm run start:dexar # ng serve --configuration=development --port 4200
npm run build # ng build
npm run build:dexar # ng build --configuration=production
npm run arch:check # boundary + circular-dependency checks
Barry Cache (repo memory, optional but recommended before/after non-trivial work):
npm run barry -- resume --task "<task>"
npm run barry -- validate
See root CLAUDE.md for the full Barry Cache workflow and memory policy.
Current status
- Frontend: ~96% of planned UI built. Storefront/Builder/Backoffice all have working UI; several polish/audit passes complete (see below).
- Backend: in progress — mostly PLANNED/mock gateways, no confirmed live backend contract beyond auth/session and storefront reads. Categories is the one domain fully wired to a real gateway.
- Storefront polish, performance audit, WCAG 2.1 AA accessibility audit, release-candidate walkthrough: all done — see FRONTEND-ROADMAP.md for the summary of each.
- Angular 22 upgrade: not started, feasibility researched — see ANGULAR22_PLAN.md (verdict: safe, ~2-3.5 days, 2 tooling blockers to clear first).
- Documentation: consolidated (this pass) — 19 one-off reports archived, 2 files renamed for clarity (
PROJECT.md→PROJECT_INDEX.md,backend/BACKEND-INTEGRATION.md→BACKEND_API.md), 1 duplicate deleted (RELEASE-NOTES.mdmerged intoCHANGELOG.md). - First client demo: upcoming — blocked on nothing documentation can fix; see KNOWN-ISSUES.md for what's still open, starting with the dead-routes finding at the top of this document.
Draft/publish for the Project Editor is still frontend-only (localStorage), no backend persistence — the single largest backend gap, see BACKEND_INTEGRATION.md §1 (Bootstrap: Draft vs Published) and §8 (Real Backend Implementation Guide).