Skip to content

CodeWithCJ/SparkyFitness

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SparkyFitness - Selfhosted alternative of MyFitnessPal

SparkyFitness is a comprehensive fitness tracking and management application designed to help users monitor their nutrition, exercise, and body measurements. It provides tools for daily progress tracking, goal setting, and insightful reports to support a healthy lifestyle.

Docs: https://codewithcj.github.io/SparkyFitness

✨ Features

🍎 Nutrition Tracking

  • Log your daily meals
  • Create and manage custom foods and categories
  • View summaries and analyze trends with interactive charts

💪 Exercise Logging

  • Record your workouts
  • Browse and search a comprehensive exercise database
  • Track fitness progress over time

💧 Water Intake Monitoring

  • Track daily hydration goals
  • Simple, quick water logging

📏 Body Measurements

  • Record body metrics (e.g. weight, waist, arms)
  • Add custom measurement types
  • Visualize progress through charts

🎯 Goal Setting

  • Set and manage fitness and nutrition goals
  • Track progress over time

🗓️ Daily Check-Ins

  • Monitor daily activity
  • Stay consistent with habit tracking

🤖 AI Nutrition Coach (SparkyAI)

  • Log food, exercise, body stats, and steps via chat
  • Upload food images to log meals automatically
  • Includes chat history and personalized guidance

🔒 User Authentication & Profiles

  • Secure login system
  • Switch between user profiles
  • Support for family access and management

📊 Comprehensive Reports

  • Generate summaries for nutrition and body metrics
  • Track long-term trends over weeks or months

🎨 Customizable Themes

  • Switch between light and dark mode
  • Designed with a minimal, distraction-free interface

Need Help?

image

🚀 Quick Start

Get SparkyFitness running in minutes:

# Clone the repository
git clone https://github.com/CodeWithCJ/SparkyFitness.git
cd SparkyFitness

# Copy environment template and edit as needed
cp docker/.env.example .env

# Start development environment (with live reloading)
./docker/docker-helper.sh dev up

# Access application at http://localhost:8080

📖 Documentation

For complete installation guides, development setup, and usage instructions, visit our comprehensive documentation:

👉 SparkyFitness Documentation Site

Quick Links

🐳 Docker Deployment

Production (recommended):

cp docker/.env.example .env  # Edit as needed
./docker/docker-helper.sh prod up
# Access at http://localhost:3004

Development:

cp docker/.env.example .env  # Edit as needed  
./docker/docker-helper.sh dev up
# Access at http://localhost:8080 (live reloading)

For detailed setup instructions, environment configuration, and troubleshooting, see the complete documentation.

⚠️ Known Issues / Beta Features ⚠️

The following features are currently in beta and may not have been thoroughly tested. Expect potential bugs or incomplete functionality:

  • AI Chatbot
  • Multi-user support
  • Family & Friends access
  • Apple Health Data integration

This application is under heavy development. Things may not work as expected due to the Supabase to PostgreSQL migration. BREAKING CHANGES might be introduced until the application is stable. You might need to change Docker/environment variables for new releases. Therefore, auto-upgrades using Watchtower or similar apps are not recommended. Read release notes for any BREAKING CHANGES.