Skip to content

fix: correct stale .env.example references to the make dev auto-create flow #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Jacob-9909 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: correct stale .env.example references to the make dev auto-create flow #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Frontend on :3500, backend on :3501, Mastra Studio on :4111, Convex dashboard on

## Setup

1. Copy `.env.example` to `.env` and fill in your keys:
1. `make dev` auto-creates a local `.env` on first run (no template to copy). Fill in your keys there:
- `TINYFISH_API_KEY` — from https://agent.tinyfish.ai/api-keys?utm_source=github&utm_medium=organic&utm_campaign=bigset-developer-2026q2
- `OPENROUTER_API_KEY` — from https://openrouter.ai/settings/keys
- `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` — from Clerk API Keys
Expand Down
2 changes: 1 addition & 1 deletion backend/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Writes to Convex via `ConvexHttpClient` in `src/convex.ts`. Import `{ convex, ap

## Environment

Required env vars (see `.env.example`):
Required env vars (loaded from the root `.env`; see `src/env.ts`):
- `CONVEX_URL` — Convex instance URL
- `CONVEX_SELF_HOSTED_ADMIN_KEY` — for system-level Convex writes (internal mutations)
- `CLERK_SECRET_KEY`, `CLERK_PUBLISHABLE_KEY` — for JWT verification
Expand Down
5 changes: 2 additions & 3 deletions backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ Fastify server that handles auth, database, and talks to TinyFish APIs.
## Running

```bash
# From the repo root:
cp .env.example .env
# Fill in the root .env file.
# From the repo root: `make dev` auto-creates a local .env on first run.
# Fill in the root .env file (no template to copy).
cd backend
npm install
npm run dev
Expand Down
6 changes: 3 additions & 3 deletions makefiles/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ ensure-admin-key:
fi

convex-env:
@test -f .env || { echo "Error: .env not found. Run: cp .env.example .env"; exit 1; }
@test -f .env || { echo "Error: .env not found. Run: make dev (it auto-creates a local .env)"; exit 1; }
@prod="$$(grep '^PROD=' .env | cut -d= -f2-)"; \
admin_key="$$(grep '^CONVEX_SELF_HOSTED_ADMIN_KEY=' .env | cut -d= -f2-)"; \
if [[ -z "$$admin_key" ]]; then \
Expand All @@ -212,7 +212,7 @@ convex-env:
'npx convex env set CLERK_JWT_ISSUER_DOMAIN "$$CLERK_JWT_ISSUER_DOMAIN" --url $(CONVEX_CLI_URL) --admin-key "$$CONVEX_SELF_HOSTED_ADMIN_KEY"'

convex-push:
@test -f .env || { echo "Error: .env not found. Run: cp .env.example .env"; exit 1; }
@test -f .env || { echo "Error: .env not found. Run: make dev (it auto-creates a local .env)"; exit 1; }
@admin_key="$$(grep '^CONVEX_SELF_HOSTED_ADMIN_KEY=' .env | cut -d= -f2-)"; \
if [[ -z "$$admin_key" ]]; then \
echo "Error: CONVEX_SELF_HOSTED_ADMIN_KEY is missing in root .env"; \
Expand All @@ -223,7 +223,7 @@ convex-push:
'npx convex deploy --url $(CONVEX_CLI_URL) --admin-key "$$CONVEX_SELF_HOSTED_ADMIN_KEY"'

seed-public-datasets:
@test -f .env || { echo "Error: .env not found. Run: cp .env.example .env"; exit 1; }
@test -f .env || { echo "Error: .env not found. Run: make dev (it auto-creates a local .env)"; exit 1; }
@cd frontend && node ../scripts/with-root-env.mjs npx convex run publicSeed:seedPublicDatasets

down: stop-local-keychain
Expand Down