Skip to content

DEPLOYMENT.md

Latest commit

 

History

History
74 lines (51 loc) · 3.31 KB

DEPLOYMENT.md

File metadata and controls

74 lines (51 loc) · 3.31 KB
Raw

Deployment

This service is safe to deploy as a small read-only portfolio demo, but it still spends GNews quota. For public links, prefer a low rate limit plus CLIENT_API_KEYS for /api/*; leave /health, /ready, /openapi.yaml, and /metrics available for inspection.

Production environment

Set these variables on the hosting platform:

Variable Suggested value Notes
GNEWS_API_KEY platform secret Required outside tests.
NODE_ENV production Enables production behavior.
PORT platform-provided or 3000 The app and Docker healthcheck both read this.
TRUST_PROXY 1 Use behind managed load balancers/proxies.
RATE_LIMIT_MAX 60 Keep demo quota burn low.
RATE_LIMIT_WINDOW_MS 60000 One-minute demo window.
CLIENT_API_KEYS generated secret Recommended for a public demo; protects /api/*.
REDIS_URL managed Redis URL Optional. Use it if the platform makes Redis cheap/easy.

Do not set GNEWS_BASE_URL in production unless you intentionally point at a compatible mock/provider. It exists for deterministic local tests, benchmarks, and CI smoke tests.

Render

  1. Create a Web Service from the GitHub repository and choose Docker deployment. Render supports Dockerfile-based services and passes configured environment variables to the running service.
  2. Set the environment variables above. Use Render secrets for GNEWS_API_KEY and CLIENT_API_KEYS.
  3. Set the health check path to /ready.
  4. Deploy, then smoke test:
BASE_URL=https://your-render-service.onrender.com QUERY=postgres CLIENT_API_KEY=your-demo-key npm run smoke

References: Render Docker, Render health checks.

Fly.io

  1. Run fly launch from the repository and let Fly detect the Dockerfile.
  2. Check the generated fly.toml; the internal service port should match PORT (use 3000 unless you change it).
  3. Set secrets:
fly secrets set GNEWS_API_KEY=... CLIENT_API_KEYS=...
  1. Deploy:
fly deploy

References: Fly Dockerfile deploys, Fly app configuration, fly deploy.

Railway

  1. Create a service from the GitHub repository. Railway can build from a Dockerfile.
  2. Add the production variables in the Railway Variables UI. If Railway does not inject a PORT for the service, set PORT=3000.
  3. Deploy, open the generated domain, and smoke test:
BASE_URL=https://your-railway-domain.up.railway.app QUERY=postgres CLIENT_API_KEY=your-demo-key npm run smoke

References: Railway Dockerfiles, Railway variables.

Demo posture

For a recruiter-facing public demo, the best default is:

  • Public: /health, /ready, /openapi.yaml, /metrics.
  • Protected with CLIENT_API_KEYS: /api/articles, /api/articles/title/:title, /api/articles/source.
  • Rate limited: RATE_LIMIT_MAX=60 or lower until you know traffic is tiny.
  • Logs: LOG_LEVEL=info, with no API keys in logs or URLs.

That gives people something real to inspect without turning your GNews quota into a public vending machine.