History

readme

Rhys Sullivan committed 8 months ago

Commit 45166641 parent 1db8d7f2 files · +4 −2Browse files

Unified · Split

2 files
  1. .env.example +2 −1
  2. README.md +2 −1
.env.example+2−1
@@ -1,6 +1,7 @@
1# All env vars live in this single root .env file.1# All env vars live in this single root .env file.
2# Sub-packages load it via `with-env` scripts (bun --env-file).2# Sub-packages load it via `with-env` scripts (bun --env-file).
3# Next.js vars are mapped from canonical names in next.config.ts.3# Env vars are read directly by the runtime; set VITE_* for client-exposed
4# values and canonical names (such as CONVEX_URL) for server/runtime usage.
4 5
5# ── Convex (required) ──6# ── Convex (required) ──
6CONVEX_DEPLOYMENT=dev:your-deployment-slug7CONVEX_DEPLOYMENT=dev:your-deployment-slug
README.md+2−1
@@ -99,7 +99,8 @@ bun run convex:codegen · 98 unmodified lines
99This repo uses a single root `.env` as the source of truth.99This repo uses a single root `.env` as the source of truth.
100 100
101- `assistant` and `executor` scripts read from root env-aware wrappers.101- `assistant` and `executor` scripts read from root env-aware wrappers.
102- `executor/apps/web/next.config.ts` maps canonical vars (like `CONVEX_URL`) into `NEXT_PUBLIC_*` values for the client.102- `executor/apps/web` is a TanStack Start app; canonical vars are consumed by the app and injected at runtime.
103- Client-facing values use `VITE_*` names where needed.
103- See `.env.example` for optional WorkOS, Stripe, tool-source API keys, and port overrides.104- See `.env.example` for optional WorkOS, Stripe, tool-source API keys, and port overrides.
104 105
105## Project Notes106## Project Notes