Skip to content

NO TICKET - Update Getting Started to reflect recent onboarding experience #369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jirhiker merged 4 commits into from
Jan 13, 2026
Merged

NO TICKET - Update Getting Started to reflect recent onboarding experience #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8bff6f3
Update Getting Started to reflect recent onboarding experience
kblake Jan 13, 2026
39bf6ef
Properly capitalize PostgreSQL
kblake Jan 13, 2026
aa009bc
Improved wording for gcs_credentials.json usage
kblake Jan 13, 2026
b639adb
Add helpful information for PostgreSQL port configuration
kblake Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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.

Expand Down
Loading