ayush2917 commited on
Commit
e861823
·
verified ·
1 Parent(s): 0e4175b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +42 -49
README.md CHANGED
@@ -1,49 +1,42 @@
1
- # Little Krishna Chatbot
2
-
3
- A birthday gift for Manavi, powered by Flask, Gemma, Stable Diffusion, and Firebase.
4
-
5
- ## Overview
6
- This app creates a Little Krishna-themed chatbot for Manavi’s birthday on April 19, 2025. It features:
7
- - A chatbot powered by Gemma (via Hugging Face Inference API).
8
- - Krishna-themed images generated by Stable Diffusion (via Hugging Face Inference API).
9
- - Chat history stored in Firebase Realtime Database.
10
- - A countdown to Manavi’s birthday.
11
- - A birthday message page with a generated image and animation.
12
-
13
- ## Setup
14
- 1. **Environment Variables**:
15
- - Add the following secrets in Hugging Face Space Settings > Secrets:
16
- - `HUGGINGFACE_API_TOKEN`: Your Hugging Face API token (read access). Obtain this from your Hugging Face account settings.
17
- - `FIREBASE_PROJECT_ID`: `birthday-d1e31`
18
- - `FIREBASE_PRIVATE_KEY_ID`: `958b15fbb225114efc1a7c163f1c6d8da9b9020d`
19
- - `FIREBASE_PRIVATE_KEY`: `-----BEGIN PRIVATE KEY-----\nMIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQCq46j6+mBUiP39\nDlLGdzFaI8oJHdjRxUObrq8Q4XuI58OvSRyAZKqotZRvQfSDImXh4J8h3clvMyxR\nDyO/CfRsscfC7lzB1X2vYp+ZccTcFzAgx2UDYZrdsJDVcWOcDJrWwoKt5GWsNKZI\n8hZgGy+qgf2vYISK9CGU149440aZ44XAso2ByC0SbZqAtWkgFX1oGkKpHuIDobtp\nGvqa+8yuB0Brqduz7LLEIAmzyoUV8Gge7DQXDF9aSmqJN4YGJW/caHYY/my+epOe\nB67NtqSMYyB+EwaFvDhbkpuY16gS+zmHckjatO/dd3Yz3/1+UnJJg6uZbF+F7okZ\n/9MGzx1fAgMBAAECggEAE8KDVZIB9YRpqgsv8xbxM/UTdX5oBcmDicrnH1KTUD9M\nV0Zi7020lhF4+mxr84XUtgudGvNkSWFnbHANuBdUlgTwjk+1lgwznkYPIlUPaEue\nGwwzV/K/T4cNGEEmPXMPrGmNZsIUJ5dm6uRjRfWey16AkPjeGpskDuvmARp2nXCL\nDZy852r/WUpdQMvLMJgjg1ixP22fytTozbXAeVo5FJrUNaWNdFZ+s5YTgIkpsZZL\n+I4hfuF/rCxeysuKZ1vYBlCgXaIlW9HgZ+xYFvHL3BFfsuhRDqdPfHpdEFB/162Y\nMQjVpS4msFrhHHVvbwCCZ+/fqjUGszN45SWeQtrHQQKBgQDitzHYDQ+LZaAprsBA\nmUQtErgNL69Fx2Egw4dSFbPGM1gbLXu0Js6udf9DHQJnDSG+0bocjvX1XwtkKoee\nhL6JHh5BopPDo3xjNyBI8fdAM4JBHeq+4IkFCyxqAkSd4x5brGMDnZdu5+QLYqTR\ncTRA+l7XG0ky726W3bUA5iwEcQKBgQDA9nTva6vEuyLBc8497mp6TuP6sInrRRRc\nq2+j9N+f0lFW0ZzsGT8n11MBr9NTP99MCNFFX5VHzhyrdPjVO5mYXRxfoI8t3q8h\nrgYBAmXo+trvT6vUArI3TrcVUtKLbk+YPlgU3Mae8Msbp5ffnyAsBipQ8WDUV3Tu\nF9uhZdrmzwKBgQDRCOwSMmiktHzqMc/dP/OWQ24j6lWG1wB8/wtj6dKp6mlQFa27\nOxTR0sYbEUJH1dnJYQJiloW9SXbtUjFdPTOYpYZsKgRoG/LyX7+Kwl6geV2dwIHS\noKB1YAoBbDnsAZ7aE6XvjXw0q+adgMRKwD/XsYGEgAoLxquGusDLJW5sYQKBgQCS\nACh8GxitUva6LthHDcTs5BIlVTwVkoAUmfZvtNEbCTRYH2O/VF7v00FQDmw0Gijn\nS+ijt+2olfAlXu0D0gOmQBU+2apcB5i1QAn0646WWHAdEEgvsxaLOHjYnoEF1KJO\nzCUzK9Tw37qeIxGLtsfN56BO/EPKhp3HpK+ekAWwCwKBgQC+8/AXnX+nfhubSHew\n9ajDGB1sOlqLEhaqLNfovkWpTImHknkehjFnVjAGbF73zVDL8UqLiAC5unO4mWyn\nnnYbaxSnaJEjJOQ2JHXkdNEI5fhD9RiehaAGaZRetjaPAJsaqdhpyw2ktIo+H7pT\nIoKIFqBpY8JAzOQMoB4nhW699g==\n-----END PRIVATE KEY-----\n`
20
- - `FIREBASE_CLIENT_EMAIL`: `[email protected]`
21
- - `FIREBASE_CLIENT_ID`: `113359261182405536589`
22
- - `FIREBASE_CLIENT_X509_CERT_URL`: `https://www.googleapis.com/robot/v1/metadata/x509/firebase-adminsdk-fbsvc%40birthday-d1e31.iam.gserviceaccount.com`
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.
 
1
+ ---
2
+ title: Little Krishna Chatbot (Docker)
3
+ emoji: 🐳🦚
4
+ colorFrom: blue
5
+ colorTo: yellow
6
+ sdk: docker
7
+ app_file: app.py
8
+ pinned: false
9
+ ---
10
+
11
+ <div align="center">
12
+ <img src="static/assets/krishna.png" width="200">
13
+ <h1>Little Krishna Chatbot</h1>
14
+ <p>Dockerized divine AI companion with secret management</p>
15
+ </div>
16
+
17
+ ## 🔐 Secret Configuration (Hugging Face Spaces)
18
+
19
+ 1. **Go to your Space Settings** → **Secrets**
20
+ 2. Add these exact secret names:
21
+
22
+ | Secret Name | Example Value | Required |
23
+ |------------|---------------|----------|
24
+ | `HUGGINGFACE_API_TOKEN` | `hf_AbCdE...` | ✅ |
25
+ | `FIREBASE_PROJECT_ID` | `your-project-id` | ✅ |
26
+ | `FIREBASE_PRIVATE_KEY` | `-----BEGIN PRIVATE KEY-----\n...` | ✅ |
27
+ | `FIREBASE_CLIENT_EMAIL` | `firebase-adminsdk@...` | ✅ |
28
+
29
+ ## 🐳 Docker Deployment
30
+
31
+ ### For Hugging Face Spaces
32
+ ```dockerfile
33
+ # Dockerfile
34
+ FROM python:3.9-slim
35
+
36
+ WORKDIR /app
37
+ COPY . .
38
+
39
+ RUN pip install --no-cache-dir -r requirements.txt
40
+
41
+ # The secrets will be automatically injected as environment variables
42
+ CMD ["python", "app.py"]