Getting StartedDeployment & Env

Deployment & Environment

The application is designed to deploy cleanly to Vercel with minimal configuration.

Deploy To Vercel

  1. Push the repository to GitHub.
  2. Import it at vercel.com/new.
  3. Add GITHUB_TOKEN as an environment variable if you want higher API limits.
  4. Deploy.

No additional platform configuration is required for a standard deployment.

Environment Variables

VariableRequiredPurpose
GITHUB_TOKENNoRaises GitHub API throughput and improves reliability for batch analysis

The token is used only on the server side in the service layer. It is never exposed to the browser.

Security Headers

The product documentation assumes the application sets the following headers through next.config.mjs:

  • X-Content-Type-Options: nosniff
  • X-Frame-Options: DENY
  • X-XSS-Protection
  • Referrer-Policy
  • Permissions-Policy

It should also disable the default Next.js fingerprint header with poweredByHeader: false.

Operational Recommendations

  • Use a dedicated GitHub token in production or preview environments.
  • Keep .env.local out of version control.
  • Expect serverless cold starts to clear the in-memory cache.

Local Vs Hosted Behavior

BehaviorLocal devVercel
In-memory cachePersists until process restartResets on cold start
Token handlingVia .env.localVia project environment variables
App entrynpm run devAutomatic build and deploy

Shareable Link Checklist

Before you send the docs or product link externally, verify:

  1. The deployment has GITHUB_TOKEN configured.
  2. The root route redirects correctly to /analyzer.
  3. A sample multi-repository analysis succeeds without rate limiting.

Next Steps

Quick StartArchitecture