Merge pull request #369 from DataIntegrationGroup/update-getting-started

NO TICKET - Update Getting Started to reflect recent onboarding experience

Author: jirhiker

.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

README.md

@@ -39,11 +39,11 @@ 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
+#### 2. Set up virtual environment and install dependencies
 
 
 <table>
@@ -90,6 +90,12 @@ pre-commit install
 # Edit `.env` to configure database connection and app settings
 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`.  
+  - On many systems, `postgresql.conf` is in the PostgreSQL data directory (for example: `/etc/postgresql/<version>/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.