Description
Now that authentication runs through SEP-10 + Freighter, there is no single document explaining how a new contributor configures and runs the project on their own machine. Several required environment variables are referenced across the code but absent from app/.env.example (e.g. STELLAR_SERVER_SECRET, STELLAR_NETWORK, STELLAR_HORIZON_URL, STELLAR_HOME_DOMAIN, NEXTAUTH_SECRET, CRON_SECRET). Without STELLAR_SERVER_SECRET, SEP-10 fails fast at runtime with no guidance, and a misconfigured STELLAR_NETWORK silently breaks login (see the network passphrase issue).
More info
- File:
app/README.md, app/.env.example, README.md
- Document the full setup path: install (
pnpm install), DB provisioning + pnpm prisma migrate dev, generating a Stellar server keypair for STELLAR_SERVER_SECRET, installing the Freighter browser extension, and which network (testnet vs public) to use for local dev.
- Enumerate every required env var with a one-line description and a safe example value; mark which are mandatory vs optional.
- Add a "How authentication works" section describing the challenge → sign → verify SEP-10 flow and how to test it locally.
- Cross-link to the SEP-10 spec and note the testnet caveat once the passphrase issue is resolved.
Description
Now that authentication runs through SEP-10 + Freighter, there is no single document explaining how a new contributor configures and runs the project on their own machine. Several required environment variables are referenced across the code but absent from
app/.env.example(e.g.STELLAR_SERVER_SECRET,STELLAR_NETWORK,STELLAR_HORIZON_URL,STELLAR_HOME_DOMAIN,NEXTAUTH_SECRET,CRON_SECRET). WithoutSTELLAR_SERVER_SECRET, SEP-10 fails fast at runtime with no guidance, and a misconfiguredSTELLAR_NETWORKsilently breaks login (see the network passphrase issue).More info
app/README.md,app/.env.example,README.mdpnpm install), DB provisioning +pnpm prisma migrate dev, generating a Stellar server keypair forSTELLAR_SERVER_SECRET, installing the Freighter browser extension, and which network (testnetvspublic) to use for local dev.