Skip to content

README setup is incomplete: env step missing and bun build is the wrong command #862

Closed
#996
Closed
README setup is incomplete: env step missing and bun build is the wrong command#862
#996
Assignees
Jaydbrown
Labels
Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationgood first issueGood for newcomerspriority:medium

Description

@IbrahimIjai
IbrahimIjai
opened on Oct 15, 2026

Following README.md → "Running the development server" (cd apps/web && bun dev) on a fresh clone gives a 500 on every page (see the VITE_NETWORK issue). The README never mentions env setup. Also:

  • "Building for production" says bun build. That's Bun's bundler CLI, not the package script. The correct command is bun run build (the root build script runs turbo build).
  • apps/web/.env.example says to copy it to .env.local, but it's full of placeholder CXXXX... contract IDs that would break the app, and it conflicts with .env.testnet (see the contract-ID issue).
  • There's no mention of VITE_INDEXER_GRAPHQL_URL or how to run the indexer locally for the web app.

Acceptance criteria

  • "Getting started" section with copy-pasteable steps from clone to a working localhost:3000, verified on a fresh clone
  • Fix bun build → bun run build
  • Rewrite .env.example to show only the vars a developer should override, with working testnet defaults
  • Add a "Troubleshooting" entry for Missing env var: VITE_*

Found while running the web app locally (bun dev, headless Chromium and axe-core sweep of every route at desktop and iPhone-13 sizes) on 2026-10-15, main @ 4c5cf1d. Contributors: follow AGENTS.md / CONTRIBUTING.md. The full commit gate must pass, with no eslint-disable, .skip, or lowered thresholds.

Activity

  1. IbrahimIjai
    added
    documentationImprovements or additions to documentation
    good first issueGood for newcomers
    priority:medium
    on Oct 15, 2026

  2. shobhamerabacha-star commented on Oct 15, 2026

    @shobhamerabacha-star
    shobhamerabacha-star
    on Oct 15, 2026

    Greetings,

    I looked into the details for "README setup is incomplete: env step missing and bun build is the wrong command" and would like to contribute the fix.

    Technical Implementation Outline:

    1. Inspect package manifest (package.json), peer dependency declarations, and module resolution.
    2. Configure explicit peer/optional dependencies and alignment to prevent missing runtime modules.
    3. Verify package lockfile generation and run isolated installation with zero manual steps.
    4. Validate full package build, typecheck, and runtime initialization succeed without errors.

    Please assign this issue to me. I will submit a clean, well-tested, and production-ready PR promptly!

  3. drips-wave
    added
    Stellar WaveIssues in the Stellar wave program
    on Oct 16, 2026

  4. Ay-obami commented on Oct 18, 2026

    @Ay-obami
    Ay-obami
    on Oct 18, 2026 – with Drips Wave
    Contributor

    @Ay-obami has applied to work on this issue as part of the Stellar Wave Program's 10th wave.

    I'll like to work on this issue

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

  5. Jaydbrown commented on Oct 18, 2026

    @Jaydbrown
    Jaydbrown
    on Oct 18, 2026 – with Drips Wave
    Contributor

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

    hello maintainer assign these isssues to me

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

  6. Ghoost-404 commented on Oct 18, 2026

    @Ghoost-404
    Ghoost-404
    on Oct 18, 2026 – with Drips Wave

    @Ghoost-404 has applied to work on this issue as part of the Stellar Wave Program's 10th wave.

    hello, i'd like to work on this issue please

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

  7. IbrahimIjai
    assigned
    Jaydbrown
    on Oct 18, 2026

  8. drips-wave commented on Oct 18, 2026

    @drips-wave
    drips-waveBot
    on Oct 18, 2026 – with Drips Wave

    Congratulations, @Jaydbrown! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on October 22, 2026.

    🧑‍💻 @Jaydbrown: 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 🌊

  9. Jaydbrown commented on Oct 18, 2026

    @Jaydbrown
    Jaydbrown
    on Oct 18, 2026
    Contributor

    Resolved in #996:

    • Fixed bun build to bun run build in README.md and the scripts table.
    • Added copy-pasteable Getting Started steps from fresh clone to working localhost:3000.
    • Documented that contract IDs are committed in packages/contracts/contracts.json and added optional local SubQuery indexer setup instructions.
    • Rewrote apps/web/.env.example with working testnet defaults and only developer-overridable settings.
    • Added a Troubleshooting entry for Missing env var: VITE_*.
  10. IbrahimIjai
    closed this as completedin #996on Oct 19, 2026

  11. drips-wave commented on Oct 19, 2026

    @drips-wave
    drips-waveBot
    on Oct 19, 2026 – with Drips Wave

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

    😎 @Jaydbrown: You earned 200 Points for completing this issue! Once the Wave's rewards are finalized, 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 documentationgood first issueGood for newcomerspriority:medium

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions