Back to portal

MERIDIAN · Documentation

Read the system before you build it.

Twenty-five documents define how this platform works and why. They are binding: implementation follows the docs, and docs change in the same commit as the code that changes behaviour.

  1. DOC 01ArchitectureSystem diagram, multi-tenant model, the three user layers, boundaries, and the locked decisions.
  2. DOC 02FrontendApp Router structure, components, the layered API client, hooks, types, and future tenant-aware areas.
  3. DOC 03BackendThe Express-style layered API tier: routes, middleware, controllers, services, models, realtime foundation.
  4. DOC 04DatabaseShared MongoDB model, the six implemented collections, tenantId isolation, indexes, and tracking ID strategy.
  5. DOC 05APIThe /api/v1 groups, the implemented auth endpoints, envelopes, and the error code registry.
  6. DOC 06AuthenticationSessions, cookies, Argon2id, enumeration defenses, role and tenant authorization, CSRF/CORS posture.
  7. DOC 07Tenant ManagementAtomic provisioning, slug rules, lifecycle matrix, list querying, password reset, and admin console.
  8. DOC 08Package ManagementTracking IDs, the five-status workflows, status/location history, atomic transactions, isolation, and console.
  9. DOC 09Platform AdminControl-plane permissions, tenant list, detail tabs, password reset, and server-authorized tenant dashboard access.
  10. DOC 10Website ConfigurationThe WebsiteConfig model, branding, sections, visibility and ordering, URL images, SEO, defaults, preview.
  11. DOC 11Tenant WebsitesHostname resolution, configuration-driven rendering, branding, sections, SEO, status behavior, local dev.
  12. DOC 12Public TrackingThe allowlisted tracking endpoint, safe errors, rate limiting, timelines, and integration boundaries.
  13. DOC 13MapsLeaflet + OSM ecosystem, geocoding abstraction, admin location picker, customer map, licensing duties.
  14. DOC 14RealtimeOne HTTP server hosting Socket.IO, room authorization, DB-first events, reconnection, lifecycle.
  15. DOC 15NotificationsV1 realtime-only notifications, connection feedback, and the documented future provider architecture.
  16. DOC 16Customer SharingTracking link generation, copy flows, WhatsApp share URL, clipboard resilience, and privacy bounds.
  17. DOC 17DeploymentVPS, PM2, Nginx, Cloudflare, environment values, build flow, Git releases, rollback, onboarding.
  18. DOC 18SecurityServer-side isolation, authN/Z, session security, validation, headers, safe public payloads, socket authorization.
  19. DOC 19EnvironmentEvery environment variable, public vs secret, local vs production principles.
  20. DOC 20Backup & RestoreAtlas backups, mongodump/mongorestore, retention, and the mandatory restore drill.
  21. DOC 21TroubleshootingWebSocket, host resolution, cookies, database, deploy, SSL — symptom to fix maps.
  22. DOC 22Production ChecklistPre-flight infrastructure list, the 22-step live smoke test, ops cadence.
  23. DOC 23TestingLayered suite (unit/integration/e2e), production-safety guard, coverage matrix, release gate.
  24. DOC 24DevelopmentPrerequisites, setup, quality gates, seeding, manual verification, troubleshooting, workflow.
  25. DOC 25Implementation RoadmapPhases 1–12 with scope, dependencies, and the standing rules for every phase.

Canonical sources: /docs/*.md in the repository · rendered here for reading.