Skip to content

Document API_URL for running the frontend without nginx #6

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
coderback merged 1 commit into from
Oct 10, 2026
Merged

Document API_URL for running the frontend without nginx #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,8 @@ ADZUNA_API_KEY=your_adzuna_api_key

# Job-site login credentials are set per user on the Profile page (stored encrypted with
# CREDENTIALS_KEY) — they are not configured here.

# Frontend only — NOT read from this file and not needed with Docker Compose (nginx routes
# /api to the API). When the frontend runs without nginx (npm run dev, Vercel), its /api
# proxy forwards to API_URL: set it in frontend/.env or the Vercel project's env vars.
# API_URL=http://localhost:8000
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,11 @@ Local (non-Docker) dev:

```bash
cd api && uvicorn app.main:app --reload # needs the env vars above, the data files and a reachable Ollama
cd frontend && npm run dev
cd frontend && npm run dev # needs API_URL (below)
```

**Frontend without nginx** (`npm run dev`, Vercel): the browser calls `/api/*` on the frontend's own origin, and `frontend/src/app/api/[...path]/route.ts` forwards those calls to `API_URL`. Set it to the API's base URL — for local dev, put `API_URL=http://localhost:8000` in `frontend/.env` (git-ignored); on Vercel, add it to the project's environment variables. Without it every `/api/*` call returns 503. Under Docker Compose nginx routes `/api` straight to the API, so `API_URL` isn't needed. On Vercel, streamed responses (analysis, the apply session) end at the function duration limit.

---

## Environment Variables
Expand All @@ -113,6 +115,7 @@ cd frontend && npm run dev
| `BRAVE_SEARCH_API_KEY` | Optional | Enables the Brave `site:` search job source |
| `ECONOMIC_INDEX_PATH` / `TASK_PENETRATION_PATH` | No | Data file paths (default `/data/...`) |
| `APP_DATA_PATH` | No | SQLite DBs, PDFs and uploaded CVs (compose: `/appdata`) |
| `API_URL` | Frontend, without nginx | Base URL of the API that the frontend's `/api/*` proxy forwards to (e.g. `http://localhost:8000`). Set in the frontend's environment, not the root `.env`; not needed under Docker Compose |

Job-site login details are set per user on the Profile page, not via env vars.

Expand Down
Loading