From 827471417559df26d3167c2fb13a39e9f937d245 Mon Sep 17 00:00:00 2001 From: Ibrahim Kabir Date: Mon, 15 Apr 2024 16:49:48 +0000 Subject: [PATCH] issue #90: refactor md --- DEVELOPER.md | 48 +++++++++++++++++------------------------------- 1 file changed, 17 insertions(+), 31 deletions(-) diff --git a/DEVELOPER.md b/DEVELOPER.md index 9807dc7..557534f 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -4,38 +4,24 @@ ### Run latest schema locally -* Setup .env environment variables - * LOUIS_DSN: Data Source Name (DSN) used for configuring a database connection in Louis's system. It should follow this pattern, replacing each variable with your own values : +1. Setup .env environment variables + * **LOUIS_DSN:** Data Source Name (DSN) used for configuring a database connection in Louis's system. It should follow this pattern, replacing each variable with your own values : `LOUIS_DSN=postgresql://PGUSER:PGPASSWORD@DB_SERVER_CONTAINER_NAME/PGBASE` - - * PGBASE: The base directory where PostgreSQL related files or resources are stored or accessed. it can be the name of your folder followed by test (ex: louis-test). - - * PGUSER: The username or role required to authenticate and access a PostgreSQL database. - - * USER: The username required for validation and access, it can be the same as PGUSER. - - * PGHOST: The hostname or IP address of the server where the PostgreSQL database is hosted. If you want to use it locally, it should be `localhost`. - - * PGPASSWORD: The password for the user authentication when connecting to the PostgreSQL database. - - * POSTGRES_PASSWORD: The password for the database, for authentication when connecting to the PostgreSQL database. - - * PGDATA: Path to the directory where PostgreSQL data files are stored. If it's not set, it will automatically select it for you. - - * OPENAI_API_KEY: The API key required for authentication when making requests to the OpenAI API. It can be found [here](https://portal.azure.com/#home). - - * OPENAI_ENDPOINT: The link used to call into Azure OpenAI endpoints. It can be found at the same place as the OPENAI_API_KEY. - - * OPENAI_API_ENGINE: The name of the model deployment you want to use (ex:ailab-gpt-35-turbo). - - * LOUIS_SCHEMA: The Louis schema within database (ex: louis_v005). - - * DB_SERVER_CONTAINER_NAME: The name of your database server container (ex: louis-db-server). - - * AILAB_SCHEMA_VERSION: The version of the schema you want to use. - -* Run database locally (see bin/postgres.sh) -* Restore latest schema dump + * **PGBASE:** The base directory where PostgreSQL related files or resources are stored or accessed. it can be the name of your folder followed by test (ex: louis-test). + * **PGUSER:** The username or role required to authenticate and access a PostgreSQL database. + * **USER:** The username required for validation and access, it can be the same as PGUSER. + * **PGHOST:** The hostname or IP address of the server where the PostgreSQL database is hosted. If you want to use it locally, it should be `localhost`. + * **PGPASSWORD:** The password for the user authentication when connecting to the PostgreSQL database. + * **POSTGRES_PASSWORD:** The password for the database, for authentication when connecting to the PostgreSQL database. + * **PGDATA:** Path to the directory where PostgreSQL data files are stored. If it's not set, it will automatically select it for you. + * **OPENAI_API_KEY:** The API key required for authentication when making requests to the OpenAI API. It can be found [here](https://portal.azure.com/#home). + * **OPENAI_ENDPOINT:** The link used to call into Azure OpenAI endpoints. It can be found at the same place as the OPENAI_API_KEY. + * **OPENAI_API_ENGINE:** The name of the model deployment you want to use (ex:ailab-gpt-35-turbo). + * **LOUIS_SCHEMA:** The Louis schema within database (ex: louis_v005). + * **DB_SERVER_CONTAINER_NAME:** The name of your database server container (ex: louis-db-server). + * **AILAB_SCHEMA_VERSION:** The version of the schema you want to use. +1. Run database locally (see bin/postgres.sh) +1. Restore latest schema dump ### before every change