Skip to content

Document required environment variables for local development #52

Description

@Railly

Context

.env.example lists the variables but the README's Getting Started does not say which are mandatory vs optional, or where to get each key. Clerk, Upstash Redis/Vector, UploadThing, and Trigger.dev are all required for the app to boot.

Task

Add a table to the README: variable, required/optional, where to obtain it, what breaks without it.

Acceptance criteria

A new contributor can go from clone to a working bun dev following only the README.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions