Master index and implementation changelog across Fund-My-Cause architecture, contracts, services, and operations.
| Document | Purpose |
|---|---|
| docs/SETUP.md | Start here — Single onboarding guide covering monorepo setup, env vars, contracts build, and troubleshooting |
| docs/contributor-onboarding.md | Detailed contributor guide, PR workflows, and standards |
| CONTRIBUTING.md | Code of conduct and contribution lifecycle |
| SECURITY.md | Security vulnerability disclosure policy |
| CHANGELOG.md | Repository release notes and version history |
Consolidated architecture specifications extracted from feature implementations:
| Module / Topic | Document | Summary |
|---|---|---|
| High-Level System Architecture | docs/architecture.md | System overview, verified data flow, and cross-boundary communication |
| Backend & Ingestion | docs/backend-architecture.md | Indexer, database models, and caching layers |
| GraphQL API Service | docs/architecture/graphql-api-service.md | Apollo Server 4, Redis cache invalidation, and WebSocket subscriptions |
| APM & Distributed Tracing | docs/architecture/apm-monitoring.md | Observability, OpenTelemetry traces, Prometheus metrics, and alerting |
| Gamification & Achievements | docs/architecture/gamification.md | Badges, leaderboard ranking, social sharing, and milestone rewards |
| RBAC & Team Management | docs/architecture/rbac-team-management.md | Multi-role campaign administration and multi-signature approval workflows |
| DevOps & Infrastructure | docs/architecture/devops-infrastructure.md | CI/CD pipelines, secret management, automated security scanning, and deployments |
| Security Hardening | docs/architecture/security-hardening.md | Contract reentrancy guards, circuit breakers, and vulnerability remediation |
| Contract Monolith Decomposition | docs/architecture/monolith-decomposition.md | Modularization strategy and crate architecture |
| Cross-Browser Testing | docs/architecture/cross-browser-testing.md | Playwright multi-engine testing specifications |
| Advanced Features | docs/architecture/advanced-features.md | Campaign milestones, refunds, and donation matching |
| ADR | Title | Status |
|---|---|---|
| ADR-001 | Pull-based refund model | Accepted |
| ADR-002 | Off-chain indexer architecture | Accepted |
| ADR-003 | GraphQL API for frontend queries | Accepted |
| ADR-004 | Soroban contract module boundaries (contracts/common) |
Proposed |
| ADR-005 | Keeping fraud_detection and recommendations as separate services |
Proposed |
| ADR-006 | Unify Frontend Chain Read Paths via GraphQL API | Proposed |
| ADR-007 | Stellar smart contract upgrade strategy & state migration | Accepted |
| Reference | Scope |
|---|---|
| docs/api/README.md | Root API documentation hub |
| docs/api/crowdfund.md | Crowdfund contract Soroban function interface |
| docs/api/registry.md | Registry contract discovery interface |
| docs/api/graphql.md | GraphQL API schema, auth headers, rate limits, and mutations |
| docs/api/events.md | Contract event signatures and payloads |
| docs/api/errors.md | Contract error codes and recovery guidance |
| docs/api/sdk-js/ | Generated @fund-my-cause/sdk TypeScript documentation |