mariagrandury commited on
Commit
cb301ac
·
1 Parent(s): 637660b

docs: explain how to launch the app in local

Browse files
Files changed (1) hide show
  1. README.md +32 -2
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- title: Transparency Self Assessment
3
  emoji: ✅
4
  colorFrom: yellow
5
  colorTo: yellow
@@ -10,4 +10,34 @@ pinned: false
10
  license: cc-by-4.0
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Transparency Self Assessment (FMTI)
3
  emoji: ✅
4
  colorFrom: yellow
5
  colorTo: yellow
 
10
  license: cc-by-4.0
11
  ---
12
 
13
+ ## Dev Guide
14
+
15
+ To set up a virtual environment and install the necessary requirements, follow these steps:
16
+
17
+ 1. Create a virtual environment:
18
+
19
+ ```
20
+ python3 -m venv venv
21
+ ```
22
+
23
+ 2. Activate the virtual environment:
24
+
25
+ - On Windows, run:
26
+ ```
27
+ venv\Scripts\activate
28
+ ```
29
+ - On Unix or MacOS, run:
30
+ ```
31
+ source venv/bin/activate
32
+ ```
33
+
34
+ 3. Install the requirements:
35
+ ```
36
+ pip install -r requirements.txt
37
+ ```
38
+
39
+ To run the app in local, run:
40
+
41
+ ```
42
+ python3 app.py
43
+ ```