Skip to content

Document local development setup and .env #199

Description

@cjmabry

Currently, it's not clear in README how to set up .env for local dev. Running #196 branch pre README instructions results in the following error:

Failed to load config file "/home/chris/dev/mailer" as a TypeScript/JavaScript module. Error: Error: DATABASE_URL environment variable is required

Oviously, a local Postgres database needs to be created, but is that all? The .env.example file has a ton of config values in them, and it's not clear which, if any, are needed for local dev, or if truly local dev is possible - there are lots of references to vercel blob storage, vercel DB's etc.

createdb mailer is easy enough, along with updating the .env, but are these needed for local dev? If so, we should come up with a solution that does not require external services for local development.

# Vercel Blob Storage for image uploads – currently in beta, please fill out this form for access: https://tally.so/r/nPDMNd. Setup instructions: https://vercel.com/docs/storage/vercel-blob/quickstart
BLOB_READ_WRITE_TOKEN=

# GitHub OAuth secrets for auth & login – generate these here: https://github-client-generator.vercel.app/
NEXTAUTH_SECRET=
AUTH_GITHUB_ID=
AUTH_GITHUB_SECRET=

# Vercel authentication token that can be found here: https://vercel.com/account/tokens
AUTH_BEARER_TOKEN=
# Vercel Project ID that can be found here: https://vercel.com/<org>/<project>/settings
PROJECT_ID_VERCEL=
# Vercel Team ID that can be found here: https://vercel.com/teams/<org>/settings
# Only required if you're using this with a Vercel team
TEAM_ID_VERCEL=

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 documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions