Skip to content

Create .env.example file for configuration reference #47

@RonaldRonnie

Description

@RonaldRonnie

Description:
New contributors and users need a reference for required and optional environment variables. Currently, this information is scattered across documentation.

Expected Behavior:

  • Create .env.example in repository root
  • Include all required environment variables
  • Include all optional environment variables with defaults
  • Add comments explaining each variable
  • Document where to get API keys

Impact:

  • Difficult onboarding for new contributors
  • Potential misconfiguration
  • Users may not know what variables are needed

Acceptance Criteria:

  • .env.example file created
  • All required variables documented
  • All optional variables documented with defaults
  • Comments explain each variable
  • Links to API key registration pages included
  • .gitignore already excludes .env (verified)

Variables to Include:

  • NCBI_API_KEY (required)
  • EMAIL (required)
  • GEMINI_API_KEY (at least one LLM required)
  • OPENAI_API_KEY (optional)
  • ANTHROPIC_API_KEY (optional)
  • LLM_PROVIDER (optional)
  • RAG_* variables (optional)
  • etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions