readme

README.md

@@ -12,26 +12,33 @@ pinned: false
 # Klìnic
 
 ## Architecture
+
 ![alt text](.assets/architecture.png "Architecture")
 
 ## Prerequisites
+
 - [git lfs](https://git-lfs.com/)
 - `pip install -r requirements.txt`
 
 ## Setup
 
 1. Get pre-processed data (large files are stored using Git LFS - you need to have it installed)
-    ```Shell
-    git lfs fetch --all
-    git lfs checkout
-    ```
+   ```Shell
+   git lfs fetch --all
+   git lfs checkout
+   ```
 2. Start the IRIS Docker container:
-    ```Shell
-    docker-compose up -d
-    ```
+   ```Shell
+   docker-compose up -d
+   ```
 3. Open a Jupyter notebook we've created to populate the database and run all the cells: [database.ipynb](./database.ipynb)
-4. Run the app: `streamlit run app.py`
+4. create a .env file and add the following variable:
+   ```
+   OPENAI_API_KEY=<your-openai-api-key>
+   ```
+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'
+  - You can execute SQL queries at 'System Explorer' → 'SQL'