README.md

Documentation

This is the documentation map for the FuTuRe platform — every markdown doc in the repository, grouped by audience. If you add a new docs file, register it here too (see CONTRIBUTING.md).

Getting Started

Document	Description
Contributing Guide	Local setup, running tests, branch naming, PR process, code style, commit conventions
Glossary	Stellar and remittance/compliance terms used in this codebase, with links to real usage
Troubleshooting	Fixes for common local dev failures — Docker ports, Prisma drift, Friendbot, npm workspaces, env vars
Backend README	Backend requirements, scripts, and directory layout
Frontend README	Frontend requirements, scripts, and directory layout
Stellar Contract README	Soroban prediction-market smart contract — purpose, build, and deploy

Architecture

Document	Description
Architecture	System diagram, component overview, payment flow walkthrough, and deployment topology
Infrastructure	Terraform configuration for deploying the platform to AWS

Guides

Document	Description
API Authentication Guide	How to obtain credentials, authenticate requests, refresh tokens, and handle auth errors — start here if you are building an integration
Security Best Practices	API key storage, CSRF protection, webhook signature verification, CSP, and known attack vectors
Streaming Payment Security	Per-stream secret encryption model and trade-offs for recurring payments
Troubleshooting	Local development environment problems — see also Getting Started above

Operations

Document	Description
Runbook	Day-to-day operational procedures — server restart, DB migration rollback, incident response, backup restore
Incident Runbooks	Step-by-step responses for Horizon outages, DB failover, JWT secret rotation, and stuck transaction recovery

Migrations

Document	Description
TypeScript Migration Plan	Backend-wide plan and conventions for the incremental JS → TS migration
Frontend TypeScript Migration Status	Frontend-specific migration status and phase tracking
React Query Migration	Migration of frontend server state from useEffect/useState to @tanstack/react-query

Testing

Document	Description
Coverage Follow-up Issues	Files with 0% test coverage, tracked as individual follow-up issues

Frontend Notes

Document	Description
XLM Info Tooltip	Accessible tooltip component explaining XLM balance labels to new users
Locale Files	Supported languages and translation file conventions

Architecture Decision Records

Architecture decisions are recorded in docs/adr/.

Historical Implementation Notes

Point-in-time write-ups of past implementation work, kept for reference. These are not maintained going forward and may describe code that has since changed — see docs/history/ for the full list:

Document	Description
Backend Auth Implementation Analysis	Status audit of the username/password backend auth implementation
Contract & Snapshot Test Summary	Issue #481 — consumer/provider contract test additions
Security Hardening Notes	Issues #439–442 — startup secret validation and related hardening
XLM Info Tooltip Summary	Accessible tooltip component for XLM balance labels
Implementation Summary: Issues #447–450	Security and backend fixes batch
Implementation Summary: Issues #559–562	Stellar account label persistence batch
React Query Migration	Migration of frontend server state to @tanstack/react-query