🚧 update readme for new setup

curieo-org · Jul 3, 2024 · 9518d08 · 9518d08
1 parent d1a2b8f
commit 9518d08
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/agency/README.md b/agency/README.md
@@ -56,6 +56,10 @@ Agency is a collection of multiple RAG modules. Every module is responsible for
 # configure the environment variables
 cp .env.template .env
 
+# Copy the environment variables from the aws secret file
+# https://eu-central-1.console.aws.amazon.com/secretsmanager/secret?name=search-agency-development-env&region=eu-central-1
+# and turn on curieo vpn
+
 # start the server
 poetry run app
 ```

diff --git a/agency/app/settings.py b/agency/app/settings.py
@@ -23,6 +23,7 @@ class SearchSettings(BaseSettings):
     api_base_url: str = "http://127.0.0.1"
     locale: str = "en-US"
 
+
 class EmbeddingSettings(BaseSettings):
     api_url: str = "http://localhost:8080"
     api_key: SecretStr
@@ -91,4 +92,5 @@ class Settings(BaseSettings):
     pubmed_cluster_qdrant: QdrantSettings
     pubmed_retrieval: PubmedRetrievalSettings = PubmedRetrievalSettings()
 
+
 app_settings = Settings()
diff --git a/agency/develop/settings.py b/agency/develop/settings.py
@@ -202,4 +202,4 @@ class Settings(BaseSettings):
     ai_models: AIModelsSettings = AIModelsSettings()
 
 
-app_settings = Settings()
+app_settings = Settings()
diff --git a/server/README.md b/server/README.md
@@ -8,6 +8,7 @@
   - [API Documentation](#api-documentation)
   - [Prerequisites](#prerequisites)
   - [Usage](#usage)
+  - [Contribution](#contribution)
   - [Deployment](#deployment)
 
 ## Introduction
@@ -47,6 +48,9 @@ Additionally, in the `.env` file, some services get additional configuration.
 # setup the environment and configure
 cp .env.template .env
 
+# Copy the environment variables from the aws secret file
+# https://eu-central-1.console.aws.amazon.com/secretsmanager/secret?name=search-server-development-env&region=eu-central-1
+# and turn on curieo vpn
 ```
 
 - database (see below)
@@ -65,7 +69,7 @@ To locally compile and run, optionally, you need to create new tables or schemas
 
 Maintain current ordering in the `migrations` directory; making sure that the order of schema creation is not create error in the database.
 
-```
+```bash
 sqlx migrate add schema_name
 
 # configure the database
Original file line number	Diff line number	Diff line change
Expand Up		@@ -202,4 +202,4 @@ class Settings(BaseSettings):
		ai_models: AIModelsSettings = AIModelsSettings()


		app_settings = Settings()
		app_settings = Settings()