docs: document every environment variable across the monorepo (#579) - #627
Closed
ZacLou wants to merge 2 commits into
Closed
docs: document every environment variable across the monorepo (#579)#627ZacLou wants to merge 2 commits into
ZacLou wants to merge 2 commits into
Conversation
added 2 commits
August 29, 2026 08:55
…LitCodes#557) - services/api.ts now imports apiUrl from security/env.ts instead of reading EXPO_PUBLIC_API_BASE_URL directly - EXPO_PUBLIC_API_BASE_URL is fully removed from the codebase - security/env.ts: corrected dev rpcUrl default from 8545 (EVM port) to 8000 (Soroban RPC port) - validateEnv() now provides detailed warnings in development when env vars are missing or still using defaults - validateEnv() is called at app start in app/_layout.tsx - Added apps/mobile/.env.example documenting EXPO_PUBLIC_APP_ENV, EXPO_PUBLIC_API_URL, and EXPO_PUBLIC_RPC_URL Closes StayLitCodes#557
…tCodes#579) Created docs/ENVIRONMENT.md listing every env var per service (backend, frontend, mobile, onchain deployment) with: - Variable name, owning service, required/optional, secret flag, default - Conflict & duplicate register (EXPO_PUBLIC_API_BASE_URL vs EXPO_PUBLIC_API_URL, NEXT_PUBLIC_API_BASE_URL vs NEXT_PUBLIC_API_URL, API_BASE_URL) - Cross-service variables that must agree (API URL, Stellar network, Soroban RPC, contract ID) - Quick start examples for each service Closes StayLitCodes#579
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Fixes #579 — creates
docs/ENVIRONMENT.mdlisting every environment variable used across the Vaultix monorepo.What's in the doc
Per-service variable listing
Each variable is documented with: name, owning service, required/optional, whether it's a secret, default value, and purpose.
Services covered:
apps/backend) — 38 variablesapps/frontend) — 5 variables (including the deprecatedNEXT_PUBLIC_API_BASE_URL)apps/mobile) — 6 variables (including the removedEXPO_PUBLIC_API_BASE_URL)Conflict & duplicate register
Explicitly identifies conflicting/duplicate variables with their canonical names and resolution status:
EXPO_PUBLIC_API_BASE_URL→EXPO_PUBLIC_API_URL(resolved in [MOBILE] Unify mobile environment configuration into a single module #557)NEXT_PUBLIC_API_BASE_URL→NEXT_PUBLIC_API_URL(flagged for migration)API_BASE_URL→ should useFRONTEND_URLorNEXT_PUBLIC_API_URLCross-service variables (must agree)
Groups variables that must be consistent across services so drift is obvious:
Quick start examples
Copy-pasteable
.envblocks for each service.Acceptance Criteria Checklist
docs/ENVIRONMENT.mdlists every environment variable per service (backend, frontend, mobile, onchain deployment)Closes #579