๐ฆ Welcome to Migraine Tracker Docs
Empowering you to find your hidden triggers and reclaim your days.
Welcome to the official documentation for Migraine Tracker, an open-source, privacy-first platform designed to help chronic pain sufferers identify correlations between their health and the environment around them.
Whether you are a user looking to understand your daily dashboard, or a developer wanting to contribute to our predictive backend engine, you are in the right place!
โ๏ธ Don't want to host it yourself? Try Migraine Pulse!
Love the project but don't want to deal with Docker, database management, and server costs? We offer an official, fully-managed cloud version at MigrainePulse.com!
By upgrading to our paid plan, you get everything in the open-source version, plus:
๐ Exclusive Premium Features (Advanced reporting & integrations)
๐พ Unlimited Space (Never worry about data caps or log limits)
๐ค Priority Support and automated daily backups
๐ Quick Links
- Live Demo Application - Try tracking today!
- Frontend Repository - React & Vite UI
- Backend Repository - NestJS Engine
- Documentation Repository - This GitBook!
๐ Where to Begin?
๐งโโ๏ธ For Users
If you are using the app and want to get the most out of your predictive tracking, head over to the User Wellness Guide. We will walk you through setting up your profile, logging your first incident, and understanding your trigger insights.
๐ป For Developers
If you want to run the stack locally, build a new feature, or integrate with our API, check out the System Architecture Overview to understand how the pieces fit together. From there, you can dive straight into the Frontend or Backend setup guides!
๐ก๏ธ Our Commitment to Privacy
Because we deal with highly sensitive medical logs, privacy isn't just a featureโit is our architectural foundation. Your data is encrypted at the application layer using dynamically rotating keys, and you have total control to export or permanently erase your history at any time. Read more in our Privacy Promise.