docs: add full local integration guide, checks, and handoff (#186)#286
Merged
Conversation
|
@0xsteins is attempting to deploy a commit to the Ijai's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
@0xsteins 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! 🚀 |
33 tasks
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.
Closes #186
Summary
Adds a single documented path for a new contributor to bring up contracts → indexer → web locally, plus automated checks (CI +
local) that catch schema, mapping, and manifest-sync regressions before review.
What's included
1.
docs/local-full-stack.md— top-level integration guideverify GraphQL → verify UI.
localvstestnetvs (future)mainnetseparation..deployed/<network>.env2. Offline fixture deployment files
apps/s03-indexer/tests/fixtures/contracts-repo/mirrors the real contracts-repo layout (.deployed/*.env,.stellar/contract-ids/local.json) so manifest sync and validation can run without a live Stellar deploy.3. Local check scripts
scripts/check-integration.sh— runs indexer codegen / build / mapping unit tests, manifest sync against fixtures, manifestvalidation, web typecheck + build.
scripts/validate-manifest.sh— checks generated manifests contain every required network field, core contract, and token (nojqdependency).
bun run check:integrationat the repo root.4. CI workflow
.github/workflows/integration-checks.yml— two parallel jobs:Test plan
bun installfrom a clean clonebun run check:integration(mirrors the new CI matrix locally)bun run --cwd apps/s03-indexer codegenbun run --cwd apps/s03-indexer buildbun run --cwd apps/s03-indexer testSO4_CONTRACTS_REPO=apps/s03-indexer/tests/fixtures/contracts-repo bun run --cwd apps/s03-indexer sync:contracts:localbash scripts/validate-manifest.sh apps/s03-indexer/config/contracts.local.jsonbun run --cwd apps/web typecheckbun run --cwd apps/web buildIntegration Checksworkflow runs green on this PRNotes
0xsteins.apps/weborapps/s03-indexer/srcchanged — this PR is docs + fixtures + tooling + CI only.