Stefano Fiorucci commited on
Commit
91a52f0
β€’
1 Parent(s): 04db216

added installation section to README

Browse files
Files changed (3) hide show
  1. README.md +9 -0
  2. crawler/README.md +1 -1
  3. requirements.dev.txt +0 -5
README.md CHANGED
@@ -22,6 +22,7 @@ WKLP is a simple Question Answering system, based on data crawled from [Twin Pea
22
 
23
  - [Project architecture 🧱](#project-architecture-)
24
  - [What can I learn from this project? πŸ“š](#what-can-i-learn-from-this-project-)
 
25
  - [Repository structure πŸ“](#repository-structure-)
26
  - [Possible improvements ✨](#possible-improvements-)
27
  ---
@@ -54,6 +55,14 @@ WKLP is a simple Question Answering system, based on data crawled from [Twin Pea
54
 
55
  Within each folder, you can find more in-depth explanations.
56
 
 
 
 
 
 
 
 
 
57
  ## Possible improvements ✨
58
  ### Project structure
59
  - The project is optimized to be deployed in Hugging Face Spaces and consists of an all-in-one Streamlit web app. In more structured production environments, I suggest dividing the software into three parts:
22
 
23
  - [Project architecture 🧱](#project-architecture-)
24
  - [What can I learn from this project? πŸ“š](#what-can-i-learn-from-this-project-)
25
+ - [Installation πŸ’»](#installation-)
26
  - [Repository structure πŸ“](#repository-structure-)
27
  - [Possible improvements ✨](#possible-improvements-)
28
  ---
55
 
56
  Within each folder, you can find more in-depth explanations.
57
 
58
+ ## Installation πŸ’»
59
+ To install this project locally, follow these steps:
60
+ - `git clone https://github.com/anakin87/who-killed-laura-palmer`
61
+ - `cd who-killed-laura-palmer`
62
+ - `pip install -r requirements.txt`
63
+
64
+ To run the web app, simply type: `streamlit run app.py`
65
+
66
  ## Possible improvements ✨
67
  ### Project structure
68
  - The project is optimized to be deployed in Hugging Face Spaces and consists of an all-in-one Streamlit web app. In more structured production environments, I suggest dividing the software into three parts:
crawler/README.md CHANGED
@@ -5,8 +5,8 @@ This crawler download texts and metadata from [Twin Peaks Fandom Wiki](https://t
5
  *Several wiki pages are discarded, since they are not related to Twin Peaks plot and create noise in the Question Answering index.*
6
 
7
  ## Installation
8
- - `pip install -r requirements.txt`
9
  - copy this folder (if needed, see [stackoverflow](https://stackoverflow.com/questions/7106012/download-a-single-folder-or-directory-from-a-github-repo))
 
10
 
11
  ## Usage
12
  - (if needed, activate the virtual environment)
5
  *Several wiki pages are discarded, since they are not related to Twin Peaks plot and create noise in the Question Answering index.*
6
 
7
  ## Installation
 
8
  - copy this folder (if needed, see [stackoverflow](https://stackoverflow.com/questions/7106012/download-a-single-folder-or-directory-from-a-github-repo))
9
+ - `pip install -r requirements.txt`
10
 
11
  ## Usage
12
  - (if needed, activate the virtual environment)
requirements.dev.txt DELETED
@@ -1,5 +0,0 @@
1
- farm-haystack[faiss]==1.4.0
2
- markdown
3
- st-annotated-text
4
- streamlit==1.2.0
5
- protobuf==3.20.1