From fc113baf48b0a2b3f5a65914ad416e47f65567cc Mon Sep 17 00:00:00 2001 From: Amrit Krishnan Date: Mon, 28 Oct 2024 11:21:27 -0400 Subject: [PATCH] Small fix to README --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d56cd03..a4d9e3f 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,19 @@ The project is built using a microservices architecture. It has the following co #### Add API keys -In the `.env.development` file in the root of the project, set the following environment variables: +In the `.env.development` file in the root of the project, set the following environment variables. + +The following are required for the backend and to fetch data from the 211 API: - `OPENAI_API_KEY` - `211_API_KEY` - - `MAPBOX_API_KEY` - `DATA_DIR` - `COLLECTION_NAME` + +The following are optional and only required if you want to use the frontend UI: + - `MAPBOX_API_KEY` + - `NEXT_PUBLIC_GOOGLE_MAPS_API_KEY` + Make sure to set appropriate values for these variables. The `CHROMA_HOST`, `CHROMA_PORT`, and `COLLECTION_NAME` are already defined in the file, but you may need to adjust their values if necessary. @@ -75,13 +81,13 @@ docker compose --env-file .env.development --profile frontend -f docker-compose. For example, to download GTA data, run the following command: ```bash -python scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --is-gta --data-dir /mnt/data/211 +python scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --is-gta --data-dir ``` To download Ontario-wide data, run the following command: ```bash -python scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --data-dir /mnt/data/211 +python scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --data-dir ``` #### Upload data and embeddings @@ -89,7 +95,7 @@ python scripts/download_data.py --api-key $YOUR_211_API_KEY --dataset on --data- First we use an interactive container: ```bash -docker run -it --network health-rec_app-network -v :/data -v `pwd`:/workspace -w /workspace vectorinstitute/health-rec:backend-dev-latest bash +docker run -it --network health-rec_app-network -v :/data -v `pwd`:/workspace -w /workspace vectorinstitute/health-rec:backend-dev-latest bash ``` Then we can run the following commands to upload the data to the vector database: