Spaces:
Runtime error
Runtime error
Update readme
Browse files
README.md
CHANGED
@@ -6,4 +6,50 @@ sdk: gradio
|
|
6 |
sdk_version: 4.25.0
|
7 |
app_file: app.py
|
8 |
pinned: false
|
9 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
6 |
sdk_version: 4.25.0
|
7 |
app_file: app.py
|
8 |
pinned: false
|
9 |
+
---
|
10 |
+
|
11 |
+
## Quickstart Guide
|
12 |
+
|
13 |
+
1. Clone the repo to your local machine
|
14 |
+
```
|
15 |
+
git clone https://huggingface.co/spaces/Hackaithon/project
|
16 |
+
```
|
17 |
+
|
18 |
+
2. Set your directory to the project folder
|
19 |
+
```
|
20 |
+
cd project
|
21 |
+
```
|
22 |
+
|
23 |
+
3. Initialize a Python virtual environment
|
24 |
+
```
|
25 |
+
python -m venv venv
|
26 |
+
```
|
27 |
+
|
28 |
+
4. Activate the virtual environment (repeat this step every time you open the terminal)
|
29 |
+
|
30 |
+
Mac:
|
31 |
+
```
|
32 |
+
source venv/bin/activate
|
33 |
+
```
|
34 |
+
|
35 |
+
Windows:
|
36 |
+
```
|
37 |
+
.\venv\Scripts\activate
|
38 |
+
```
|
39 |
+
|
40 |
+
5. Install requirements
|
41 |
+
```
|
42 |
+
pip install -r requirements.txt
|
43 |
+
```
|
44 |
+
|
45 |
+
6. Create your .env file locally
|
46 |
+
```
|
47 |
+
cp .env.example .env
|
48 |
+
```
|
49 |
+
|
50 |
+
7. Copy and paste the OpenAI API key into the .env file you just created
|
51 |
+
|
52 |
+
8. Run the app
|
53 |
+
```
|
54 |
+
python app.py
|
55 |
+
```
|