This repository houses the design and technical documentation for the RemitLend platform. It provides a single source of truth for architecture diagrams, UI/UX designs, transaction flow specifications, and the in‑repo wiki that contains deeper technical references.
- remitlend – The main application codebase (frontend + backend). This docs repo explains the design decisions that drive that code.
- remitlend-backend – Backend services; see the design docs here for API contracts and data flow.
- remitlend-contracts – Soroban smart contracts; the wiki contains contract state‑machine diagrams and sync flows.
- remitlend-frontend – Front‑end UI; the UI/UX design docs describe the components and interactions implemented there.
| Document | Summary |
|---|---|
| DESIGN.md | Product, UI/UX, and gamification design specifications |
| LANDING_PAGE_DESIGN.md | Landing page layout, marketing copy, and visual assets |
| TRANSACTION_PREVIEW.md | Detailed design of the transaction preview interface |
| wiki/README.md | Overview of the in‑repo wiki and how to contribute |
| wiki/contract-state-machine.md | Soroban contract state‑machine diagram and description |
| wiki/indexer-sync-flow.md | Flow of data syncing between the indexer and the database |
| wiki/frontend-patterns.md | Common frontend patterns and "standard library" components |
If you’d like to add or improve documentation, start by reading our contribution guide: CONTRIBUTING.md.
- Follow the markdown style guide (headings, code blocks, mermaid diagrams).
- Use the provided templates for reference, how‑to, and design pages.
- Submit changes via a PR; reviewers will ensure consistency and completeness.
Have questions? Open an issue or reach out to the maintainers.