SMACKZ Platform Wiki
Welcome to the internal documentation for the SMACKZ platform -- a multi-tenant restaurant SaaS powering online ordering, menu management, loyalty programs, and analytics for restaurant brands.
What is SMACKZ?
SMACKZ provides everything a restaurant needs to run its digital presence: a customizable website, mobile app, admin dashboard, POS integration, kitchen display system, and an analytics lakehouse. Each restaurant gets its own branded experience while sharing a common platform infrastructure.
Quick Links
| Area | Description |
|---|---|
| Platform Overview | High-level architecture and service layout |
| Yum Backend API | The core REST API powering all clients |
| Local Development | Getting started with Docker Compose |
| Conventions | Git, database, and coding rules |
| FRD Index | All functional requirements documents |
Service Inventory
| Service | Purpose | Tech |
|---|---|---|
| Yum | Backend API (menus, orders, auth, pages) | Node.js, Fastify, Drizzle ORM |
| Smackz-Admin | Restaurant owner dashboard | React 19, Redux Toolkit |
| Smackz-Websites | Customer-facing restaurant websites | React 19, TailwindCSS v4 |
| SMACKZ-MOBILE | Customer mobile app | React Native CLI |
| Page Renderer | Web renderer for dynamic pages | React |
| POS Adapters | Clover POS integration | Node.js, Fastify |
| MCP Server | AI/LLM integration via Model Context Protocol | Python 3.12, FastMCP |
| KDS-Web | Kitchen display system | React, Vite |
| Lakehouse | Analytics platform (Writer + Query API + Metabase) | Python, DuckDB, Parquet |
| Shared Core / UI | Shared npm packages for auth, API, types, components | TypeScript |
How This Wiki is Organized
- Architecture -- System-level diagrams, service map, data flow, tech stack
- Services -- One page per deployable service with setup, structure, and key APIs
- Lakehouse -- The analytics platform: ingestion, querying, dashboards, data quality
- Domains -- Business domain guides: orders, menus, auth, restaurants, loyalty, payments, notifications, delivery, theming, visual editor
- Infrastructure -- Local dev, CI/CD, team conventions
- FRDs -- Index of all functional requirements documents