From 69a2112df962eff7e4f3d75b79f437da210e396c Mon Sep 17 00:00:00 2001 From: KS Jannette Date: Sat, 28 Mar 2026 08:27:06 -0400 Subject: [PATCH] update readme --- backend/README.md | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/backend/README.md b/backend/README.md index 25f7123..d579bf4 100644 --- a/backend/README.md +++ b/backend/README.md @@ -1,20 +1,28 @@ Start DB: -brew services start postgresql@15 +## 1. brew services start postgresql@15 -From the backend directory, you have a few options: + OR -Option 1: Single command (both API + poller) -cd /Users/kjannette/workspace/koin_ping_0.2.0/backendmake dev-all + /opt/homebrew/opt/postgresql@15/bin/pg_ctl -D /opt/homebrew/var/postgresql@15 start -Option 2: Two separate terminals -Terminal 1 (API server): -cd /Users/kjannette/workspace/koin_ping_0.2.0/backend go run ./cmd/api -Terminal 2 (Poller): -cd /Users/kjannette/workspace/koin_ping_0.2.0/backend go run ./cmd/poller +## 2. From the backend directory, you have a few options: -make run — Builds and runs the API server. -make dev — Runs the API server with auto-reload via air (falls back to go run if air isn't installed). -make poller — Builds and runs the poller. -make poller-dev — Runs the poller with auto-reload. -make dev-all — Runs both the API and poller concurrently. \ No newline at end of file +## 3. Option 1: Single command (both API + poller) + cd /Users/kjannette/workspace/koin_ping_0.2.0/backendmake dev-all + +## 4. Option 2: Two separate terminals + Terminal 1 (API server): + cd /Users/kjannette/workspace/koin_ping_0.2.0/backend go run ./cmd/api + + make run — Builds and runs the API server. + make dev — Runs the API server with auto-reload via air (falls back to go run if air isn't installed). + +## 5. Terminal 2 (Poller): + cd /Users/kjannette/workspace/koin_ping_0.2.0/backend go run ./cmd/poller + + make poller — Builds and runs the poller. + make poller-dev — Runs the poller with auto-reload. + +## 6. ALLIN ONE: + Make dev-all — Runs both the API and poller concurrently. \ No newline at end of file