SPAYD Applied Documentation
Live Demo: https://pexmor.github.io/spayd-applied/app/
Comprehensive documentation for the SPAYD Applied suite of applications.
📚 Documentation Index
Getting Started
- User Guide - Complete user documentation with screenshots and tutorials
- Quick Start - Fast setup for all components
Technical Documentation
- AGENTS.md - Architecture overview and design decisions for developers and AI agents
- Development Guide - Setup, contribution guidelines, and development workflow
- API Reference - REST API documentation for FioFetch backend
Component Guides
Additional Resources
🎯 Quick Links by Role
For Users
For Developers
For DevOps
🚀 Live Demos
- SPAYD QR Generator: https://pexmor.github.io/spayd-applied/
- Batch Processor: https://pexmor.github.io/spayd-applied/app/batch.html
- FioFetch: Self-hosted (see Docker Guide)
📖 Documentation Structure
docs/
├── README.md # This file - documentation index
├── USER_GUIDE.md # End-user documentation
├── DEVELOPMENT.md # Developer setup and guidelines
├── API.md # REST API reference
├── BATCH.md # Batch payment processing guide
├── FIOFETCH.md # Transaction fetcher guide
└── FIOFETCH_CHANGES.md # Recent changes and fixes
Root-level documentation:
├── README.md # Project overview (minimal)
├── AGENTS.md # Architecture for developers/AI
├── CHANGELOG.md # Version history
└── DOCKER.md # Docker deployment guide
🔍 What’s What?
SPAYD QR Generator (Main App)
Generate Czech QR payment codes (SPAYD format) for banking apps.
- Docs: User Guide
- Tech: Preact, TypeScript, IndexedDB
- Use case: Individual payment requests
Batch Payment Processor
Generate multiple payment requests with email templates.
- Docs: Batch Guide
- Tech: Preact, TypeScript, XLSX parsing
- Use case: Event invoicing, bulk payments
FioFetch
Fetch and manage transactions from Fio Bank API.
- Docs: FioFetch Guide
- Tech: Python FastAPI, SQLite, Docker
- Use case: Transaction history, reconciliation
🛠️ Common Tasks
I want to…
Generate a single QR payment:
→ User Guide: Generate QR Payment
Send payment requests to multiple people:
→ Batch Guide: Quick Start
Fetch my bank transactions:
→ FioFetch Guide: Getting Started
Deploy with Docker:
→ Docker Guide: Quick Start
Contribute to the project:
→ Development Guide: Contributing
Understand the architecture:
→ AGENTS.md: Architecture
Use the REST API:
→ API Reference
Fix a 422 error in FioFetch:
→ FioFetch: Understanding History Limit
💡 Key Features
SPAYD QR Generator
- ✅ Offline-first (works without internet)
- ✅ Account and event management
- ✅ Payment history tracking
- ✅ Optional webhook sync
- ✅ Czech and English languages
Batch Processor
- ✅ Excel/CSV import
- ✅ Personalized email generation
- ✅ Batch QR code export
- ✅ Variable Symbol auto-generation
- ✅ Payment tracking
FioFetch
- ✅ Automatic transaction fetching
- ✅ SQLite storage
- ✅ REST API
- ✅ WebSocket updates
- ✅ JSON/CSV export
- ✅ Docker deployment
🆘 Getting Help
Documentation
- Check the relevant guide above
- Review AGENTS.md for technical details
- Read troubleshooting sections
Common Issues
Reporting Issues
Include:
- Which component (main app, batch, FioFetch)
- Steps to reproduce
- Error messages or logs
- Expected vs actual behavior
📝 Documentation Principles
This documentation follows these principles:
- Single Source of Truth - No duplicate or conflicting information
- Minimal Root - Only README, AGENTS, CHANGELOG, DOCKER in root
- Comprehensive docs/ - All detailed guides here
- Cross-referenced - Links between related documents
- User-focused - Written for both humans and AI agents
- Current - Updated with code changes
🔄 Recent Updates
See CHANGELOG.md for version history.
Latest features:
- ✨ History limit (zárazka) for FioFetch
- 🔒 Token masking in logs
- 🐛 Fixed Fio Bank API URL
- 📚 Comprehensive documentation restructure
Need something specific? Check the User Guide or AGENTS.md!