tableeee-v3 / HUGGINGFACE_DEPLOYMENT_GUIDE.md
Shyamnath's picture
feat(core): implement unified database with multi-hotel support and session management
90537f3
# πŸ€— Hugging Face Spaces Deployment Guide for Tabble-v3
## πŸš€ Quick Deployment
### Step 1: Prepare Repository
```bash
git clone https://github.com/your-username/tabble-v3.git
cd tabble-v3
# Verify required files exist:
# βœ“ Dockerfile, app.py, requirements.txt
# βœ“ templates/, app/, hotels.csv
```
### Step 2: Create Hugging Face Space
1. Go to [https://huggingface.co/new-space](https://huggingface.co/new-space)
2. Configure:
- **Space name**: `tabble-v3-restaurant`
- **SDK**: Docker
- **License**: MIT
3. Connect your GitHub repository
4. Add metadata to README.md:
```yaml
---
title: Tabble-v3 Restaurant Management
emoji: 🍽️
colorFrom: blue
colorTo: purple
sdk: docker
app_port: 7860
license: mit
tags: [restaurant, management, fastapi, qr-code]
---
```
### Step 3: Monitor Build
- Watch build logs in "Logs" tab
- Wait for "Running on http://0.0.0.0:7860" message
- Verify health check at `/health` endpoint
## πŸ“± Using Your App
### Access URLs
- **Home**: `your-space-url/`
- **Customer**: `your-space-url/customer`
- **Chef**: `your-space-url/chef`
- **Admin**: `your-space-url/admin`
- **API Docs**: `your-space-url/docs`
### Demo Credentials
- **Hotel Access Code**: `myhotel`
- **Tables**: 1-20
- **Phone OTP**: Any 6 digits
## πŸ”§ Customization
### Add Your Hotel
Edit `hotels.csv`:
```csv
hotel_database,password
your_restaurant.db,secure_password_123
```
### Menu Setup
1. Access admin panel with hotel code
2. Go to "Manage Dishes"
3. Add menu items with images and pricing
## πŸš‘ Troubleshooting
### Common Issues
1. **Build fails**: Check Dockerfile and requirements.txt
2. **App won't start**: Verify port 7860 and database init
3. **Templates missing**: Ensure templates/ directory exists
### Debug Steps
1. Check Space logs for errors
2. Test `/health` endpoint
3. Verify admin panel loads with demo credentials
## πŸ“Š Production Ready
### Security
- Update hotel passwords in `hotels.csv`
- Set `SECRET_KEY` environment variable
### Features
- Upload menu images to `app/static/images/`
- Customize branding in templates
- Configure real SMS/payment services
**Your restaurant management system is now live!** πŸŽ‰