docs: document local setup, required env vars, and stellar auth flow#395
Merged
Merged
Conversation
|
@HassanKorey Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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.
Description
Closes #346
This PR standardizes the local setup documentation across the repository and explicitly documents the Stellar web authentication (SEP-10) flow. It ensures new contributors have a single source of truth for bootstrapping the database, configuring their wallet, and successfully authenticating against the local dev environment.
What Changed:
app/.env.example: Enumerated all environment variables with one-line descriptions, explicit(Mandatory)/(Optional)tags, and included the missingSTELLAR_NETWORKandSTELLAR_HORIZON_URLvariables. Changed defaults tolocalhost:3000to be safe for local dev.app/README.md: Expanded the setup guide to include generating a Stellar Testnet keypair, installing the Freighter extension, and ensuring it is set to Testnet. Added a dedicated "How Authentication Works" section detailing the SEP-10 challenge -> sign -> verify flow with a caveat regarding theSTELLAR_NETWORKconfiguration.README.md(root): Standardized package manager commands to usepnpm(aligning withapp/README.md) and added a direct pointer to the Next.js app README for setup and auth flow instructions.Note on Issue Discrepancy: The issue mentioned that
STELLAR_SERVER_SECRET,STELLAR_HOME_DOMAIN,NEXTAUTH_SECRET, andCRON_SECRETwere missing fromapp/.env.example. These were actually already present in the file, so I preserved them while adding the missing network variables and descriptions.Checklist
npx prisma generateafter schema changesnpx prisma migrate devornpx prisma migrate deployas appropriatePost-Merge Steps for Maintainers
If this PR includes changes to the Prisma schema: (N/A for this PR)
Run the following command to apply the migration to your database: