From 8bff6f31706f34ae710000c70e91fc0006baa647 Mon Sep 17 00:00:00 2001 From: Karmen Blake Date: Tue, 13 Jan 2026 13:49:42 -0800 Subject: [PATCH 1/4] Update Getting Started to reflect recent onboarding experience --- .env.example | 4 ++-- README.md | 8 ++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.env.example b/.env.example index 74fa5874..d93d9811 100644 --- a/.env.example +++ b/.env.example @@ -2,9 +2,9 @@ DB_DRIVER=postgres POSTGRES_USER=admin POSTGRES_PASSWORD=password -POSTGRES_DB= +POSTGRES_DB=ocotillo POSTGRES_HOST=localhost -POSTGRES_PORT=5432 +POSTGRES_PORT=54321 # Connection pool configuration for parallel transfers # pool_size: number of persistent connections to maintain diff --git a/README.md b/README.md index aaa47bad..aee9ee3e 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,8 @@ supports research, field operations, and public data delivery for the Bureau of #### 1. Clone the repository ```bash -git clone https://github.com/DataIntegrationGroup/NMSampleLocations.git -cd NMSampleLocations +git clone https://github.com/DataIntegrationGroup/OcotilloAPI.git +cd OcotilloAPI ``` #### 2. Set up virtual environment and install depdencies @@ -90,6 +90,10 @@ pre-commit install # Edit `.env` to configure database connection and app settings cp .env.example .env ``` +Notes: +* Create file gcs_credentials.json, and get contents from a teammate and place it in the root directory of the project. +* Postgresql port is 54321 (default is 5432). Update your postgresql.conf to `port = 54321` + In development set `MODE=development` to allow lexicon enums to be populated. From 39bf6ef75d62a2036ca34f5434462d4e13f8eb4b Mon Sep 17 00:00:00 2001 From: Karmen Blake Date: Tue, 13 Jan 2026 14:19:46 -0800 Subject: [PATCH 2/4] Properly capitalize PostgreSQL Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aee9ee3e..33eebd8b 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ cp .env.example .env ``` Notes: * Create file gcs_credentials.json, and get contents from a teammate and place it in the root directory of the project. -* Postgresql port is 54321 (default is 5432). Update your postgresql.conf to `port = 54321` +* PostgreSQL port is 54321 (default is 5432). Update your postgresql.conf to `port = 54321` In development set `MODE=development` to allow lexicon enums to be populated. From aa009bc52d08681bf07fd3324d483b796ac0be72 Mon Sep 17 00:00:00 2001 From: Karmen Blake Date: Tue, 13 Jan 2026 14:20:21 -0800 Subject: [PATCH 3/4] Improved wording for gcs_credentials.json usage Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 33eebd8b..aa30d2b0 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ pre-commit install cp .env.example .env ``` Notes: -* Create file gcs_credentials.json, and get contents from a teammate and place it in the root directory of the project. +* Create file gcs_credentials.json in the root directory of the project, and obtain its contents from a teammate. * PostgreSQL port is 54321 (default is 5432). Update your postgresql.conf to `port = 54321` From b639adb949cb126d471335c9978a2664795263b3 Mon Sep 17 00:00:00 2001 From: Karmen Blake Date: Tue, 13 Jan 2026 14:49:33 -0800 Subject: [PATCH 4/4] Add helpful information for PostgreSQL port configuration --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index aa30d2b0..37f625db 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ git clone https://github.com/DataIntegrationGroup/OcotilloAPI.git cd OcotilloAPI ``` -#### 2. Set up virtual environment and install depdencies +#### 2. Set up virtual environment and install dependencies @@ -92,8 +92,10 @@ cp .env.example .env ``` Notes: * Create file gcs_credentials.json in the root directory of the project, and obtain its contents from a teammate. -* PostgreSQL port is 54321 (default is 5432). Update your postgresql.conf to `port = 54321` - +* PostgreSQL port is 54321 (default is 5432). Update your `postgresql.conf` to `port = 54321`. + - On many systems, `postgresql.conf` is in the PostgreSQL data directory (for example: `/etc/postgresql//main/postgresql.conf` on Debian/Ubuntu, `/var/lib/pgsql/data/postgresql.conf` on many RPM-based distros, or `/usr/local/var/postgres/postgresql.conf` for Homebrew on macOS). + - You can find the exact location from `psql` with: `SHOW config_file;` + - After changing the port, restart PostgreSQL so the new port takes effect. In development set `MODE=development` to allow lexicon enums to be populated.