README.md

Ta-Da! Documentation

Welcome to the Ta-Da! documentation. This directory contains guides for deployment, development, and API usage.

📚 Documentation Index

Getting Started

• ENVIRONMENTS.md - NEW - Environment configuration guide
  • Localhost development setup
  • Self-hosted deployment
  • Database path strategy
• DEPLOYMENT.md - Complete deployment guide
  • CapRover deployment (recommended)
  • Docker deployment
  • Database setup and migrations
  • REST API v1 setup
  • Security checklist

REST API v1

Documentation for the REST API v1 (released in v0.3.1):

• tada-api/API-SPECIFICATION.md - Complete API reference
  • All 24 endpoints documented
  • Request/response examples
  • Authentication with API keys
  • Rate limiting
• tada-api/CHANGELOG.md - API version history
• tada-api/README.md - API overview
• tada-api/AGENTS-API.md - Agent integration guide
• tada-api/OPENCLAW-SKILL.md - OpenClaw skill documentation

Development

• DEVELOPER_GUIDE.md - Development setup and guidelines
• PROJECT_STRUCTURE.md - Codebase organization
• testing/TESTING.md - Testing guide and best practices

Features & Modules

• modules/ - Module index and architecture overview
  • Timeline, Ta-Da!, Moments, Sessions, Tally, Rhythms
  • Importers, Exporters & Sync
• ../MODULES.md - Developer guide for creating new modules

Architecture & Implementation

• VOICE_AI_ARCHITECTURE.md - Voice AI implementation details
• ERROR_HANDLING.md - Error handling patterns
• CSV_IMPORT_COMPLETION_REVIEW.md - Import feature review
• DATABASE_LOCATION_MIGRATION.md - Database migration guide

Legacy / Reference

• DEPLOY_CAPROVER.md - Original CapRover guide (see DEPLOYMENT.md instead)
• dev/ - Development notes and version-specific docs
• plans/ - Feature planning documents

Other

• CREDITS.md - Attributions and credits
• terminal-behavior.md - Terminal UI behavior notes

🚀 Quick Links

For deploying Ta-Da!: → Start with DEPLOYMENT.md

For using the REST API: → See tada-api/API-SPECIFICATION.md

For contributing: → Read DEVELOPER_GUIDE.md

For testing: → Check testing/TESTING.md

📦 Version Information

• App Version: v0.5.0
• REST API Version: v1.0.0
• Last Updated: 2026-03-10

🔗 Related Resources

• GitHub Repository: https://github.com/InfantLab/tada
• Live Demo: https://tada.living
• API Health Check: https://tada.living/api/health

---

Need help? Open an issue on GitHub or check the relevant documentation section above.