ayush2917 commited on
Commit
bf29aac
·
verified ·
1 Parent(s): 829839d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +24 -1
README.md CHANGED
@@ -23,4 +23,27 @@ This app creates a Little Krishna-themed chatbot for Manavi’s birthday on Apri
23
  - `FIREBASE_DATABASE_URL`: `https://birthday-d1e31-default-rtdb.firebaseio.com/`
24
 
25
  2. **Dependencies**:
26
- - The `requirements.txt` file includes all necessary Python dependencies:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
  - `FIREBASE_DATABASE_URL`: `https://birthday-d1e31-default-rtdb.firebaseio.com/`
24
 
25
  2. **Dependencies**:
26
+ - The `requirements.txt` file includes all necessary Python dependencies:
27
+ flask==2.3.2
28
+ requests==2.31.0
29
+ firebase-admin==6.2.0
30
+ python-dotenv==1.0.0
31
+
32
+ 3. **Hardware**:
33
+ - Use the CPU basic tier (2 vCPU, 16 GB, free) in Hugging Face Space Settings.
34
+
35
+ 4. **Restart Space**:
36
+ - After adding files and secrets, restart the Space to deploy the app.
37
+
38
+ ## Usage
39
+ - **Home Page**: See the countdown to Manavi’s birthday and a Krishna animation.
40
+ - **Chat Page**: Chat with Little Krishna and generate a comic strip by saying “Tell me a story!”
41
+ - **Birthday Message Page**: View a generated Krishna image and Ayush’s birthday message for Manavi.
42
+
43
+ ## Configuration
44
+ - **Entry Point**: The app uses `main.py` as the entry point, which imports the Flask app from `app.py`.
45
+ - **Python Version**: The app requires Python 3.9, as specified in `Space.yaml`.
46
+ - **Templates and Static Files**: The app uses templates in the `templates/` directory and static files in the `static/` directory.
47
+ - **Models Used**:
48
+ - `google/gemma-2b` for the chatbot.
49
+ - `runwayml/stable-diffusion-v1-5` for image generation.