Skip to content
Maja Dabcevic edited this page May 5, 2025 · 12 revisions

Welcome to the mk2 wiki!


Page Description
🏁 Getting Started How to set up and run the project locally or with Docker
🏗️ Architecture Overview High-level system design and tech stack overview
🔐 Authentication & Authorization User roles, JWT, and access policies
📦 API Reference REST API endpoints (or Swagger link)
🧪 Testing Strategy How unit/integration tests are structured and run
🌍 Deployment CI/CD, Docker Compose, and environment setup
📈 Analytics & Notifications Real-time systems and event handling
🤝 Contributing Code style, PR flow, commit guidelines
🗺️ Roadmap Planned features and release goals

🧭 About the Project

The platform allows guests to:

  • Scan a QR code to view the menu.
  • Place orders without logging in.
  • Call staff or request the bill via phone.

And enables staff to:

  • Manage tables, orders, and notifications.
  • Track business performance with real-time updates.

Clone this wiki locally