SyedHasanCronosPMC commited on
Commit
4e37d29
ยท
verified ยท
1 Parent(s): 90c2a67

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +72 -0
README.md ADDED
@@ -0,0 +1,72 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: "๐Ÿฝ๏ธ Restaurant Menu Generator"
3
+ emoji: "๐Ÿœ"
4
+ colorFrom: "indigo"
5
+ colorTo: "pink"
6
+ sdk: gradio
7
+ sdk_version: "4.24.0" # (or leave blank to use latest)
8
+ app_file: app.py
9
+ pinned: true
10
+ ---
11
+
12
+ # ๐Ÿฝ๏ธ AI Restaurant Menu Generator
13
+
14
+ An AI-powered app that:
15
+ - Suggests a fancy restaurant name based on the cuisine type.
16
+ - Generates a structured fine-dining menu (Starters, Main Course, Drinks with suggested prices).
17
+
18
+ Built using **LangChain**, **OpenAI**, and **Gradio**.
19
+
20
+ ---
21
+
22
+ ## โœจ Features
23
+ - Uses LLM chains to first generate a brand-worthy restaurant name.
24
+ - Then creates a beautifully structured menu.
25
+ - Ideal for entrepreneurs, chefs, and creative projects.
26
+
27
+ ๐Ÿ‘จโ€๐Ÿ’ป Built by [Syed Ali Hasan](https://www.linkedin.com/in/syedalihasannaqvi/)
28
+
29
+ > ๐Ÿ” **Note:** You must set the `OPENAI_API_KEY` in the "Secrets" section of your Hugging Face Space settings.
30
+
31
+ ---
32
+
33
+ ## ๐Ÿ› ๏ธ Usage
34
+
35
+ Just type in a cuisine (like "Japanese" or "Moroccan") and click **Generate Menu**.
36
+
37
+ You'll get:
38
+ - A unique restaurant name.
39
+ - 3 sections of menu with premium dish names, descriptions, and prices.
40
+
41
+ ---
42
+
43
+ ### Example
44
+
45
+ **Input:** `"Italian"`
46
+
47
+ **Output:**
48
+ - *Restaurant Name:* *La Tavola dโ€™Oro*
49
+ - *Starters:* Burrata Basilico, etc.
50
+ - *Main Course:* Truffle Tagliatelle, etc.
51
+ - *Drinks:* Limoncello Breeze, etc.
52
+
53
+ ---
54
+
55
+ ## ๐Ÿ’ก Tech Stack
56
+ - `Gradio`
57
+ - `LangChain`
58
+ - `OpenAI API`
59
+
60
+ ---
61
+
62
+ ## ๐Ÿ” Deployment Note
63
+
64
+ This space requires an OpenAI key. Set it in your Spaceโ€™s secrets:
65
+ - Go to **Settings โ†’ Secrets**
66
+ - Add key: `OPENAI_API_KEY`
67
+
68
+ ---
69
+
70
+ This should **immediately resolve the configuration error** and make your Hugging Face Space look polished and professional.
71
+
72
+ Would you like me to also create a banner image or favicon for the space UI?