Overview

Welcome to the comprehensive documentation for SparkyFitness, a self-hosted alternative to MyFitnessPal with AI-powered nutrition assistance.

Disclaimer: While we strive to keep this documentation as accurate and up-to-date as possible, some sections may occasionally become outdated. If you encounter any issues or have questions, please reach out via our GitHub Discussions or join our Discord community where others can help you.

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 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.

Table of Contents