Skip to content

Local development setup guide #541

Closed

Description

@codebestia

Write docs/development-setup.md: a start-to-finish guide for getting all four apps running locally. Cover prerequisites (Node 20, pnpm, Rust + wasm32-unknown-unknown, uv for Python, Docker for infra/docker-compose.yml), bringing up Postgres/Redis/MinIO, seeding env files from .env.example, running migrations, and starting each app. Include the scripts/start-web.sh helper and the Makefile targets.

Acceptance criteria:

  • Every prerequisite is listed with the version this repo actually expects
  • infra/docker-compose.yml's four services (postgres, redis, minio, minio-init) are explained
  • The exact command sequence from clean clone to a running app is given and verified by following it
  • Documents which parts work without Docker (tests mock Redis/Postgres/S3 by policy) and which genuinely need it
  • Common first-run failures are covered or cross-linked to the troubleshooting doc

Activity

  1. Sunshine5325 commented on Aug 27, 2026

    @Sunshine5325

    @Sunshine5325 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

    Hello, with relevant experience, i can work on this fix, kindly assign.

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @Sunshine5325 to this issue.

  2. vickydve commented on Aug 30, 2026

    @vickydve
    Contributor

    @vickydve has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

    Hi, I'd like to work on this issue. I'll write docs/development-setup.md as a start-to-finish local setup guide, listing every prerequisite with the version this repo expects (Node 20, pnpm, Rust + wasm32-unknown-unknown, uv, Docker), explaining infra/docker-compose.yml's four services (postgres, redis, minio, minio-init), and walking through seeding env files from .env.example, running migrations, and starting each app, including the scripts/start-web.sh helper and Makefile targets. I'll follow the exact command sequence from a clean clone myself to verify it works, note which parts need Docker versus which are mocked in tests, and cross-link the troubleshooting doc for common first-run failures before opening a PR.

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @vickydve to this issue.

  3. drips-wave commented on Aug 30, 2026

    @drips-wave

    Congratulations, @vickydve! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.

    🧑‍💻 @vickydve: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

    Warning

    When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

    🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

    🌊 Happy Wave 🌊

  4. github-actions commented on Aug 30, 2026

    @github-actions

    Closed by #596, merged into dev.

  5. drips-wave commented on Aug 30, 2026

    @drips-wave

    This issue has been completed by @vickydve as part of the Stellar Wave Program's 8th Wave 🥳

    😎 @vickydve: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.

    🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationdx

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions