Skip to content

Document API_URL for running the frontend without nginx - #6

Merged
coderback merged 1 commit into
mainfrom
docs/api-url
Oct 10, 2026
Merged

coderback merged 1 commit into
mainfrom
docs/api-url

Conversation

@coderback

Copy link
Copy Markdown
Owner

Documents API_URL, which the frontend's /api/* proxy (fixed in #5) needs whenever nginx is not in front of it. Docs only; no code changes.

Changes

  • README, Environment Variables: new API_URL row.
  • README, local dev: a "Frontend without nginx" paragraph covering what the variable is, where to set it (frontend/.env locally, project env vars on Vercel), that /api/* returns 503 without it, that Docker Compose doesn't need it, and that streamed responses on Vercel end at the function duration limit. The npm run dev line now notes it needs API_URL.
  • .env.example: a commented API_URL=http://localhost:8000 entry, marked as a frontend variable that is not read from the root .env.

Checked

Ran npm run dev with API_URL in frontend/.env against a local test backend; an /api call was forwarded correctly.

Not changed

  • frontend/.env.local is not git-ignored, which is why the docs point to frontend/.env (ignored by the root .env rule).
  • NEXT_PUBLIC_API_URL=/api in docker-compose.yml is not read by anything.

The frontend's /api proxy needs API_URL when nginx is not in front
(npm run dev, Vercel). Add it to the README's environment table and
local-dev steps, and as a commented entry in .env.example.
@coderback
coderback merged commit 1f322ea into main Oct 10, 2026
3 checks passed
@coderback
coderback deleted the docs/api-url branch October 10, 2026 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant