Mariem-Daha commited on
Commit
d74b75c
Β·
verified Β·
1 Parent(s): c236cb2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +78 -68
README.md CHANGED
@@ -1,68 +1,78 @@
1
- # 🍳 ChefCode - AI Restaurant Management
2
-
3
- An AI-powered restaurant inventory and recipe management system with voice recognition and web recipe search.
4
-
5
- ## πŸš€ Features
6
-
7
- - **AI Assistant**: Voice and text commands for inventory and recipe management
8
- - **Web Recipe Search**: Find and import recipes from TheMealDB
9
- - **Inventory Management**: Track ingredients with quantities and prices
10
- - **Recipe Management**: Create, edit, and manage recipes
11
- - **Voice Recognition**: Hands-free operation with continuous conversation
12
-
13
- ## 🎯 Quick Start
14
-
15
- 1. **Open the app** - The interface will load automatically
16
- 2. **Enable microphone** when prompted for voice commands
17
- 3. **Try these commands**:
18
- - 🎀 "Add 5 kg of flour at 2 euros per kg"
19
- - 🎀 "Search for pasta recipes"
20
- - 🎀 "Add recipe Pizza with flour 500 grams and tomato 200 ml"
21
-
22
- ## πŸ€– AI Assistant Commands
23
-
24
- ### Inventory Management
25
- - "Add 5 kg of rice at 2.50 euros per kg"
26
- - "Update flour to 10 kg"
27
- - "Remove tomatoes from inventory"
28
- - "How much rice do we have?"
29
-
30
- ### Recipe Management
31
- - "Add recipe Pizza with flour 100 kg and tomato sauce 200 ml"
32
- - "Search for Italian pasta recipes"
33
- - "Edit recipe Pizza by adding 2 grams of salt"
34
- - "Show me all dessert recipes"
35
-
36
- ## 🌐 Web Recipe Search
37
-
38
- 1. Go to **Recipes** section
39
- 2. Click **"Search Recipe from Web"**
40
- 3. Search for any recipe (e.g., "Italian pasta", "chicken soup")
41
- 4. View results and import with AI ingredient mapping
42
-
43
- ## 🎨 Interface
44
-
45
- - **Modern Design**: Clean, responsive interface
46
- - **Voice-First**: Optimized for hands-free operation
47
- - **Color-Coded Results**: Visual feedback for ingredient matching
48
- - **Real-Time Updates**: Live data synchronization
49
-
50
- ## πŸ”§ Technical Details
51
-
52
- - **Backend**: FastAPI with SQLite database
53
- - **AI Models**: OpenAI GPT-4o-mini and GPT-o3
54
- - **Frontend**: Modern web interface with voice recognition
55
- - **External APIs**: TheMealDB for recipe discovery
56
-
57
- ## πŸ“Š Database
58
-
59
- The app uses SQLite for data storage with the following tables:
60
- - `inventory_items` - Inventory data
61
- - `recipes` - Recipe data with JSON ingredients
62
- - `tasks` - Production tasks
63
-
64
- ## πŸŽ‰ Enjoy ChefCode!
65
-
66
- Perfect for restaurant managers, chefs, and kitchen staff who want to streamline their operations with AI-powered tools.
67
-
68
- **Start by clicking the microphone button and saying your first command!** 🎀✨
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: ChefCode - AI Restaurant Management
3
+ emoji: 🍳
4
+ colorFrom: 'blue'
5
+ colorTo: 'gray'
6
+ sdk: docker
7
+ sdk_version: "1.0"
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+ # 🍳 ChefCode - AI Restaurant Management
12
+
13
+ An AI-powered restaurant inventory and recipe management system with voice recognition and web recipe search.
14
+
15
+ ## πŸš€ Features
16
+
17
+ - **AI Assistant**: Voice and text commands for inventory and recipe management
18
+ - **Web Recipe Search**: Find and import recipes from TheMealDB
19
+ - **Inventory Management**: Track ingredients with quantities and prices
20
+ - **Recipe Management**: Create, edit, and manage recipes
21
+ - **Voice Recognition**: Hands-free operation with continuous conversation
22
+
23
+ ## 🎯 Quick Start
24
+
25
+ 1. **Open the app** - The interface will load automatically
26
+ 2. **Enable microphone** when prompted for voice commands
27
+ 3. **Try these commands**:
28
+ - 🎀 "Add 5 kg of flour at 2 euros per kg"
29
+ - 🎀 "Search for pasta recipes"
30
+ - 🎀 "Add recipe Pizza with flour 500 grams and tomato 200 ml"
31
+
32
+ ## πŸ€– AI Assistant Commands
33
+
34
+ ### Inventory Management
35
+ - "Add 5 kg of rice at 2.50 euros per kg"
36
+ - "Update flour to 10 kg"
37
+ - "Remove tomatoes from inventory"
38
+ - "How much rice do we have?"
39
+
40
+ ### Recipe Management
41
+ - "Add recipe Pizza with flour 100 kg and tomato sauce 200 ml"
42
+ - "Search for Italian pasta recipes"
43
+ - "Edit recipe Pizza by adding 2 grams of salt"
44
+ - "Show me all dessert recipes"
45
+
46
+ ## 🌐 Web Recipe Search
47
+
48
+ 1. Go to **Recipes** section
49
+ 2. Click **"Search Recipe from Web"**
50
+ 3. Search for any recipe (e.g., "Italian pasta", "chicken soup")
51
+ 4. View results and import with AI ingredient mapping
52
+
53
+ ## 🎨 Interface
54
+
55
+ - **Modern Design**: Clean, responsive interface
56
+ - **Voice-First**: Optimized for hands-free operation
57
+ - **Color-Coded Results**: Visual feedback for ingredient matching
58
+ - **Real-Time Updates**: Live data synchronization
59
+
60
+ ## πŸ”§ Technical Details
61
+
62
+ - **Backend**: FastAPI with SQLite database
63
+ - **AI Models**: OpenAI GPT-4o-mini and GPT-o3
64
+ - **Frontend**: Modern web interface with voice recognition
65
+ - **External APIs**: TheMealDB for recipe discovery
66
+
67
+ ## πŸ“Š Database
68
+
69
+ The app uses SQLite for data storage with the following tables:
70
+ - `inventory_items` - Inventory data
71
+ - `recipes` - Recipe data with JSON ingredients
72
+ - `tasks` - Production tasks
73
+
74
+ ## πŸŽ‰ Enjoy ChefCode!
75
+
76
+ Perfect for restaurant managers, chefs, and kitchen staff who want to streamline their operations with AI-powered tools.
77
+
78
+ **Start by clicking the microphone button and saying your first command!** 🎀✨