Update Readme

README.md

@@ -9,19 +9,30 @@ app_file: app.py
 pinned: false
 ---
 
-# hackupc-24
+# Klìnic
 
 ## Architecture
 ![alt text](.assets/architecture.png "Architecture")
 
+## Prerequisites
+- [git lfs](https://git-lfs.com/)
+- `pip install -r requirements.txt`
+
 ## Setup
 
-1. Start the IRIS Docker container:
+1. get pre-processed data
+    ```Shell
+    git lfs fetch --all
+    git lfs checkout
+    ```
+2. Start the IRIS Docker container:
     ```Shell
-    docker-compose up
+    docker-compose up -d
     ```
-2. Start a Jupyter Notebook
-3. Navigate to http://localhost:52773/csp/sys/UtilHome.csp to access IRIS and login with username: `demo`, password: `demo`
+3. Start a Jupyter Notebook
+4. before using the web app for the first time, run [database.ipynb](./database.ipynb)
+5. run the app: `streamlit run app.py`
+
+## Debugging
+- Navigate to http://localhost:52773/csp/sys/UtilHome.csp to access IRIS and login with username: `demo`, password: `demo`
     - You can execute SQL queries at 'System Explorer' → 'SQL'
-4. run [vector_search.ipynb](./vector_search.ipynb)
-5. run the frontend: `streamlit run app.py`