DjPapzin commited on
Commit
15e30a7
1 Parent(s): 5e43125

feat: Add Hugging Face Spaces configuration to README.md

Browse files

Added the necessary YAML configuration block to the README.md file to enable Hugging Face Spaces integration. This configuration includes project details such as title, emoji, colors, SDK, and version. Additionally, made minor adjustments to the README.md content for clarity.

Files changed (1) hide show
  1. README.md +11 -36
README.md CHANGED
@@ -1,3 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
1
  # AI Survey Bot Recommendation
2
 
3
  This is a Streamlit app that allows users to answer a couple of questions and get a tailor-made response from an AI chatbot. The chatbot uses OpenAI GPT-3.5 Turbo to generate responses based on the user's input.
@@ -14,39 +25,3 @@ This is a Streamlit app that allows users to answer a couple of questions and ge
14
 
15
  ```bash
16
  git clone https://github.com/your-username/your-repo.git
17
- ```
18
-
19
- 2. Install the dependencies:
20
-
21
- ```bash
22
- pip install -r requirements.txt
23
- ```
24
-
25
- 3. Set up the environment variables:
26
-
27
- - Create a `.env` file in the root directory of the project.
28
- - Add the following variables to the `.env` file:
29
-
30
- ```plaintext
31
- OPENAI_API_KEY=your-openai-api-key
32
- EMAIL=your-email
33
- PASSWORD=your-password
34
- ```
35
-
36
- 4. Run the app:
37
-
38
- ```bash
39
- streamlit run app.py
40
- ```
41
-
42
- ## Usage
43
-
44
- 1. Open the app in your browser.
45
- 2. Answer the questions presented on the app.
46
- 3. Click the "Submit" button to get the chatbot response.
47
- 4. The chatbot response will be displayed on the app.
48
- 5. The chatbot response will also be sent to the email address provided.
49
-
50
- ## License
51
-
52
- This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
 
1
+ ---
2
+ title: AI Survey Bot Recommendation
3
+ emoji: 🤖
4
+ colorFrom: green
5
+ colorTo: blue
6
+ sdk: streamlit
7
+ sdk_version: 1.1.0
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
  # AI Survey Bot Recommendation
13
 
14
  This is a Streamlit app that allows users to answer a couple of questions and get a tailor-made response from an AI chatbot. The chatbot uses OpenAI GPT-3.5 Turbo to generate responses based on the user's input.
 
25
 
26
  ```bash
27
  git clone https://github.com/your-username/your-repo.git