Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md is missing necessary guidance / updates #95

Open
JakeUrban opened this issue Dec 24, 2024 · 0 comments
Open

README.md is missing necessary guidance / updates #95

JakeUrban opened this issue Dec 24, 2024 · 0 comments

Comments

@JakeUrban
Copy link
Contributor

There were a couple issues I ran into trying to follow the README:

  • I got errors about using an incompatible stellar-core version. I resolved this by updating the image specified in docker-compose.yaml to stellar/stellar-rpc rather than stellar/soroban-rpc.
  • Some environment variables are required but probably shouldn't be for local development (TRACKER_DSN), and others probably deserve some guidance on how to get appropriate values (CHANNEL_ACCOUNT_ENCRYPTION_PASSPHRASE, DISTRIBUTION_ACCOUNT_PRIVATE_KEY, etc.)

I think the README is also missing some key info that would help contributors:

  • How to run tests on their machine (ideally w/o docker)
  • Referencing the API documentation in /openapi
  • Documentation for the supported environment variables (or at least the required ones)
@JakeUrban JakeUrban added bug Something isn't working and removed bug Something isn't working labels Dec 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant