Merge pull request #37 from akprinciple/feat/readme_to_match_the_actual_stack

feat/readme_to_match_the_actual_stack

Author: ogazboiz

.env.example

@@ -1,18 +1,79 @@
-# ── Required ─────────────────────────────────────────────────────────────────
-# Backend API base URL — MUST be set in production.
-# Missing this in production will cause a startup error.
-# Example: https://api.remitlend.com
+# ==============================================================================
+# REMITLEND FRONTEND - ENVIRONMENT VARIABLES TEMPLATE
+# ==============================================================================
+# Copy this file to '.env.local' or '.env' for local development.
+# Fill in values as appropriate for your local or production environment.
+# ==============================================================================
+
+# ── API & Deployment Config ──────────────────────────────────────────────────
+
+# Purpose: The base URL of the RemitLend Express Backend API.
+# Used by client pages and hooks (like useApi, useNotificationStream) to fetch off-chain details.
+# Example: http://localhost:3001
 NEXT_PUBLIC_API_URL=http://localhost:3001
 
-# ── Sentry Configuration ──────────────────────────────────────────────────────
+# Purpose: The frontend public base URL, used to configure openGraph meta tags and site metadata.
+# Example: http://localhost:3000
+NEXT_PUBLIC_SITE_URL=http://localhost:3000
+
+
+# ── Stellar & Soroban Config ─────────────────────────────────────────────────
+
+# Purpose: The Stellar network the application interacts with.
+# Example: TESTNET, PUBLIC (Mainnet), FUTURENET, STANDALONE
+NEXT_PUBLIC_STELLAR_NETWORK=TESTNET
+
+# Purpose: The RPC endpoint URL of the Soroban network.
+# Example: https://soroban-testnet.stellar.org
+NEXT_PUBLIC_STELLAR_RPC_URL=https://soroban-testnet.stellar.org
+
+# Purpose: The network passphrase for transaction builders to sign transactions on the target network.
+# Example: "Test SDF Network ; September 2015" (for Testnet) or "Public Global Stellar Network ; October 2015" (for Mainnet)
+NEXT_PUBLIC_STELLAR_NETWORK_PASSPHRASE=Test SDF Network ; September 2015
+
+# Purpose: The base URL for the Stellar Expert block explorer (without trailing slash).
+# Used to generate external links to check transactions or accounts.
+# Example: https://stellar.expert/explorer/testnet
+NEXT_PUBLIC_STELLAR_EXPLORER_URL=https://stellar.expert/explorer/testnet
+
+# Purpose: The Horizon API URL to fetch account balances and information.
+# Example: https://horizon-testnet.stellar.org
+NEXT_PUBLIC_HORIZON_URL=https://horizon-testnet.stellar.org
+
+
+# ── Smart Contract IDs ────────────────────────────────────────────────────────
+
+# Purpose: The Soroban contract ID for the Loan Manager contract.
+# Example: CC1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwx (leave blank if not deployed)
+NEXT_PUBLIC_LOAN_MANAGER_CONTRACT_ID=
+
+# Purpose: The Soroban contract ID for the overall Manager contract.
+# Example: CC1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwx (leave blank if not deployed)
+NEXT_PUBLIC_MANAGER_CONTRACT_ID=
+
+# Purpose: The Soroban contract ID for the Remittance NFT contract.
+# Example: CD1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwx (leave blank if not deployed)
+NEXT_PUBLIC_NFT_CONTRACT_ID=
+
+
+# ── Sentry Error Monitoring & Tracking ────────────────────────────────────────
+
+# Purpose: Public Sentry DSN for client-side error reporting and performance tracking.
+# Example: https://a1b2c3d4e5f6g7h8i9j0@o0.ingest.sentry.io/0
 NEXT_PUBLIC_SENTRY_DSN=
+
+# Purpose: Private Sentry DSN for server-side / Edge runtime error reporting.
+# Example: https://a1b2c3d4e5f6g7h8i9j0@o0.ingest.sentry.io/0
 SENTRY_DSN=
+
+# Purpose: Sentry Organization slug/identifier used during build to upload source maps.
+# Example: remitlend
 SENTRY_ORG=
+
+# Purpose: Sentry Project slug/identifier used during build to associate error reports.
+# Example: remitlend-frontend
 SENTRY_PROJECT=
-SENTRY_AUTH_TOKEN=
-NODE_ENV=development
 
-# Stellar Explorer base URL (no trailing slash)
-# Mainnet: https://stellar.expert/explorer/public
-# Testnet: https://stellar.expert/explorer/testnet (default)
-NEXT_PUBLIC_STELLAR_EXPLORER_URL=https://stellar.expert/explorer/testnet
+# Purpose: Private Sentry authentication token allowing Sentry CLI to upload build source maps.
+# Example: sntryu_1234567890abcdef...
+SENTRY_AUTH_TOKEN=