From ef913172321db43edee51ecfc8fdea1dc0ace106 Mon Sep 17 00:00:00 2001 From: MartinBraquet Date: Fri, 12 Sep 2025 15:29:17 +0200 Subject: [PATCH] Add local dev info --- .env.example | 17 +++++++++++++++-- package.json | 4 ++-- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/.env.example b/.env.example index 69fa83e..86be3f4 100644 --- a/.env.example +++ b/.env.example @@ -2,14 +2,27 @@ # Required variables for basic local functionality -# For database connection. A 16-character password with digits and letters. -SUPABASE_DB_PASSWORD= +# For database read access. +# Ask the project admin. Should start with "eyJh". NEXT_PUBLIC_SUPABASE_KEY= # For authentication. # Ask the project admin. Should start with "AIza". NEXT_PUBLIC_FIREBASE_API_KEY= + +# Optional variables for the backend server functionality (modifying user data, etc.) + +# For database write access. +# A 16-character password with digits and letters. +# Ideally this secret should not be shared, even to the developers. +# TODO: set up local Postgres instead of Supabase for local development, add instructions to README, and remove this variable. +SUPABASE_DB_PASSWORD= + +# For Firebase access. +GOOGLE_APPLICATION_CREDENTIALS_DEV="[...].json" +GOOGLE_APPLICATION_CREDENTIALS_PROD="${GOOGLE_APPLICATION_CREDENTIALS_DEV}" + # The URL where your local backend server is running. # You can change the port if needed. NEXT_PUBLIC_API_URL=localhost:8088 diff --git a/package.json b/package.json index 2c564a2..5c38068 100644 --- a/package.json +++ b/package.json @@ -13,8 +13,8 @@ "scripts": { "verify": "yarn --cwd=common verify:dir; yarn --cwd=web verify:dir; yarn --cwd=backend/shared verify:dir", "lint": "yarn --cwd=web lint-fix; eslint common --fix ; eslint backend/api --fix ; eslint backend/shared --fix", - "dev": "./dev.sh dev", - "prod": "./dev.sh prod", + "dev": "./run_local.sh dev", + "prod": "./run_local.sh prod", "test": "jest", "test:watch": "jest --watch", "test:coverage": "jest --coverage",