docs: Add comprehensive development environment setup guide #38
Conversation
…o help understand env variables for local dev
|
@srivatsan0611 is attempting to deploy a commit to the anirudhkamath's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Would love for you to review this @kamath when you find the time. |
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for setting up the development environment, making it easier for new contributors to get started with local development.
Key Changes:
- Created detailed environment variable setup guide covering all required and optional configuration across the monorepo
- Added reference link in README.md to the new documentation for streamlined onboarding
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/DEV_ENV_SETUP.md | New comprehensive guide documenting environment variables for packages/db/.env, apps/backend/.env, and apps/web/.env, including setup instructions for PostgreSQL, WorkOS AuthKit, Vercel AI Gateway, PostHog, and an advanced section on generating test API keys |
| README.md | Updated step 2 of setup instructions to reference the new DEV_ENV_SETUP.md documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1 participant
Purpose
Adds detailed documentation for setting up environment variables during local development.
Changes
docs/DEV_ENV_SETUP.mdwith setup instructions for all environment variables acrosspackages/db/.env,apps/backend/.env, andapps/web/.envREADME.mdto link to the new documentation in step 2 of the setup processThis is just to help facilitate more contributions towards this repo by ensuring a smoother dev local setup process :)