Write architecture and developer onboarding documentation

[ogazboiz]

Join our community: https://t.me/+DOylgFv1jyJlNzM0

Description

There is no architecture document explaining how the three components (contract, backend, frontend) interact, or how to run the project end-to-end. New contributors cannot onboard without asking questions.

What Needs to Happen

• docs/ARCHITECTURE.md:
  • Mermaid system diagram: contract → event worker → DB → SSE → frontend
  • Data flow for each event type (created, topped_up, paused, etc.)
  • Pause/resume timing model (how paused seconds are excluded from accrual)
  • Database schema overview
• docs/DEVELOPMENT.md:
  • Prerequisites (Rust, Node 20, Stellar CLI, Postgres)
  • Step-by-step local setup
  • Running against testnet vs local sandbox
  • Common troubleshooting (indexer not syncing, SSE not connecting)
• Link both docs from README

Files

• docs/ARCHITECTURE.md (create)
• docs/DEVELOPMENT.md (create)

Acceptance Criteria

• New contributor can run the project using only the docs
• Mermaid diagram renders on GitHub
• Pause/resume timing model clearly explained

[binayyub4211]

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

Hi maintainer

Can you please assign me I want to work on this issue

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

[Samuel1505]

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

please assign me this

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

[drips-wave]

Congratulations, @Samuel1505! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on April 29, 2026.

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

[drips-wave]

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

😎 @Samuel1505: 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.