fix: local dev setup for running backend outside Docker (#62)

Author: pthmas

.env.example

@@ -2,6 +2,11 @@
 # POSTGRES_USER=atlas
 # POSTGRES_PASSWORD=atlas
 
+# PostgreSQL connection string.
+# When running the full Docker stack: set automatically by docker-compose (do not set here).
+# When running the backend locally against a local or Docker Postgres:
+# DATABASE_URL=postgres://atlas:atlas@localhost:5432/atlas
+
 # Required: Your L2 RPC endpoint
 RPC_URL=http://localhost:8545
 

README.md

@@ -31,7 +31,7 @@ just frontend-install
 Start the backend:
 
 ```bash
-just backend-server
+just backend-run
 ```
 
 Start frontend:
@@ -59,7 +59,7 @@ Copy `.env.example` to `.env` and set `RPC_URL`. Common options:
 | Variable | Description | Default |
 |----------|-------------|---------|
 | `RPC_URL` | Ethereum JSON-RPC endpoint | Required |
-| `DATABASE_URL` | PostgreSQL connection string | Set in docker-compose |
+| `DATABASE_URL` | PostgreSQL connection string | `postgres://atlas:atlas@localhost:5432/atlas` (local dev) |
 | `START_BLOCK` | Block to start indexing from | `0` |
 | `BATCH_SIZE` | Blocks per indexing batch | `100` |
 | `RPC_REQUESTS_PER_SECOND` | RPC rate limit | `100` |

docker-compose.yml

@@ -1,6 +1,8 @@
 services:
   postgres:
     image: postgres:16-alpine
+    ports:
+      - "5432:5432"
     environment:
       POSTGRES_DB: atlas
       POSTGRES_USER: ${POSTGRES_USER:-atlas}