π Add proper README with Space metadata
Browse files
README.md
CHANGED
|
@@ -1,36 +1,61 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: ScanMenu
|
| 3 |
+
emoji: π±
|
| 4 |
+
colorFrom: green
|
| 5 |
+
colorTo: blue
|
| 6 |
+
sdk: docker
|
| 7 |
+
pinned: false
|
| 8 |
+
license: mit
|
| 9 |
+
short_description: Digital menus & QR ordering for restaurants
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
+
# π± ScanMenu β Digital Menus & QR Ordering
|
| 13 |
+
|
| 14 |
+
**Production-ready SaaS web app** for restaurants to create digital menus, generate QR codes, and let customers scan to view menu & order instantly β no app needed.
|
| 15 |
+
|
| 16 |
+
## β¨ Features
|
| 17 |
+
|
| 18 |
+
- π **Auth System** β Login/Register with role-based access (Admin, Owner, Staff, Customer)
|
| 19 |
+
- π½οΈ **Restaurant Profile** β Full restaurant setup with branding, hours, contact info
|
| 20 |
+
- π **Menu Builder** β CRUD for menus, categories, products with options, extras, allergens
|
| 21 |
+
- π· **Product Management** β Images, pricing, preparation time, calories, tags
|
| 22 |
+
- π± **QR Code Manager** β Generate & manage QR codes per restaurant/table
|
| 23 |
+
- π **Cart & Checkout** β Full ordering flow with dine-in/takeaway/delivery support
|
| 24 |
+
- π **Analytics Dashboard** β Revenue, orders, popular items, peak hours
|
| 25 |
+
- π³ **Stripe Billing** β Subscription plans (Free/Starter/Pro/Enterprise)
|
| 26 |
+
- π¦ **Order Management** β Real-time order tracking with status workflow
|
| 27 |
+
- π¨ **Premium SaaS UI** β Stripe/Linear-inspired dashboard design
|
| 28 |
+
|
| 29 |
+
## π οΈ Tech Stack
|
| 30 |
+
|
| 31 |
+
- **Framework:** Next.js 16 (App Router)
|
| 32 |
+
- **UI:** React, Tailwind CSS, Radix UI, Lucide Icons
|
| 33 |
+
- **State:** Zustand
|
| 34 |
+
- **Database Types:** Full PostgreSQL/Supabase schema
|
| 35 |
+
- **Payments:** Stripe integration ready
|
| 36 |
+
- **Animations:** Framer Motion
|
| 37 |
+
|
| 38 |
+
## π± Pages
|
| 39 |
+
|
| 40 |
+
| Page | Route |
|
| 41 |
+
|------|-------|
|
| 42 |
+
| Landing | `/` |
|
| 43 |
+
| Pricing | `/pricing` |
|
| 44 |
+
| Login | `/login` |
|
| 45 |
+
| Register | `/register` |
|
| 46 |
+
| Dashboard | `/overview` |
|
| 47 |
+
| Menu Builder | `/menu-builder` |
|
| 48 |
+
| QR Manager | `/qr-manager` |
|
| 49 |
+
| Orders | `/orders` |
|
| 50 |
+
| Analytics | `/analytics` |
|
| 51 |
+
| Billing | `/billing` |
|
| 52 |
+
| Restaurant Setup | `/restaurant-setup` |
|
| 53 |
+
| Settings | `/settings` |
|
| 54 |
+
| Public Menu | `/restaurant/the-garden-kitchen` |
|
| 55 |
+
|
| 56 |
+
## π Quick Demo
|
| 57 |
+
|
| 58 |
+
1. Visit the **Landing Page** to see the marketing site
|
| 59 |
+
2. Click **"View Demo Menu"** to see the customer-facing menu
|
| 60 |
+
3. Click **"Sign In"** β credentials are pre-filled β enter the **Dashboard**
|
| 61 |
+
4. Explore Menu Builder, QR Manager, Orders, Analytics, and Billing
|