Skip to content

Document required environment variables and startup instructions in README #17

@KochC

Description

@KochC

Problem

There is no documented start command or list of required environment variables. Contributors cloning the repo must inspect index.js to discover how to run the proxy.

Why now

Undocumented configuration causes onboarding friction and increases the chance of misconfigured deployments.

Acceptance criteria

  • README.md lists every environment variable read by index.js with type, default, and description
  • README.md includes a quickstart section with npm install and npm start
  • package.json has a start script pointing to the correct entry point

Target files

  • README.md
  • package.json

Suggested validation

  • A developer with no prior context can run the proxy following only the README
  • npm start launches the server without error when env vars are set

Created by autobot — risk: low

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions