Frequently Asked Questions (FAQ)

This section provides answers to common questions about SparkyFitness.

General Questions

  • What is SparkyFitness? 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.
  • Is SparkyFitness free? SparkyFitness is open-source software. Please check the project's GitHub repository for licensing details.

Technical Questions

  • How do I install SparkyFitness? Please refer to the Installation Guide for detailed instructions on how to install SparkyFitness using various methods.
  • What are the system requirements? System requirements vary depending on your chosen installation method (Docker, local development, etc.). Generally, you will need Docker, Node.js, and PostgreSQL. Refer to the Installation Guide for specifics.

Troubleshooting

  • "Invalid key length" error during setup This error typically indicates that your SPARKY_FITNESS_API_ENCRYPTION_KEY in your .env file is not correctly configured. Ensure it is a 64-character hexadecimal string, as mentioned in the example .env file and installation guides. You can generate a valid key using openssl rand -hex 32 or node -e "console.log(require('crypto').randomBytes(32).toString('hex'))".

Getting Help

If you can't find the answer to your question here, please consider:

  • Joining our Discord community: A great place to ask questions and get help from other users and developers.
  • Checking GitHub Discussions: Look for existing discussions or start a new one to get support.
  • Reporting an issue: If you believe you've found a bug, please report it on our GitHub Issues page.
Table of Contents