SparkyFitness Documentation
Welcome to the comprehensive documentation for SparkyFitness, a self-hosted alternative to MyFitnessPal with AI-powered nutrition assistance.
What is SparkyFitness?
SparkyFitness is a full-stack fitness tracking application that helps you monitor nutrition, exercise, body measurements, and achieve your health goals. Built with modern web technologies and designed for self-hosting, it provides complete control over your fitness data.
Key Features
- ๐ Nutrition Tracking - Log meals, create custom foods, analyze trends
- ๐ช Exercise Logging - Record workouts, browse exercise database
- ๐ Body Measurements - Track weight, measurements, visualize progress
- ๐ค AI Nutrition Coach - Chat-based food logging with image recognition
- ๐ฏ Goal Setting - Set and track fitness and nutrition goals
- ๐ Comprehensive Reports - Detailed analytics and progress tracking
- ๐ Privacy-First - Self-hosted with complete data control
Architecture
SparkyFitness is built with:
- Frontend: React 18 + TypeScript + Vite + Tailwind CSS
- Backend: Node.js + Express + PostgreSQL
- AI Integration: Multi-provider support (OpenAI, Anthropic, Google)
- Deployment: Docker containers with development and production configurations
- Security: Row Level Security, JWT authentication, encrypted API keys
Documentation Sections
- Getting Started - Complete setup guide for development and production
- Development Workflow - Developer guide and coding standards
- Docker Guide - Container deployment and configuration
- Features Overview - Complete feature documentation
- Contributing Guide - How to contribute to the project
- Database Schema - Database structure and design
- App Overview - High-level architecture
Getting Help
- ๐ฌ Discord Community: Join our Discord
- ๐ GitHub Discussions: Ask questions and share ideas
- ๐ Issues: Report bugs and request features
- ๐ Documentation: Comprehensive guides in this docs site
License
SparkyFitness is open source software. Please check the repository for license details.