HamzaAri commited on
Commit
3ef62a0
Β·
verified Β·
1 Parent(s): e1ef9fc

πŸ“ Add proper README with Space metadata

Browse files
Files changed (1) hide show
  1. README.md +61 -36
README.md CHANGED
@@ -1,36 +1,61 @@
1
- This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
2
-
3
- ## Getting Started
4
-
5
- First, run the development server:
6
-
7
- ```bash
8
- npm run dev
9
- # or
10
- yarn dev
11
- # or
12
- pnpm dev
13
- # or
14
- bun dev
15
- ```
16
-
17
- Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18
-
19
- You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
20
-
21
- This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
22
-
23
- ## Learn More
24
-
25
- To learn more about Next.js, take a look at the following resources:
26
-
27
- - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28
- - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
29
-
30
- You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
31
-
32
- ## Deploy on Vercel
33
-
34
- The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
35
-
36
- Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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