Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crmne/cluster-headache-tracker
Cluster Headache Tracker is a free, open-source web application designed to help individuals suffering from cluster headaches track and manage their condition. By providing detailed logging, visual insights, and easy sharing with healthcare providers, this tool aims to improve the understanding and treatment of cluster headaches.
https://github.com/crmne/cluster-headache-tracker
cluster-headache health rails ruby
Last synced: 3 days ago
JSON representation
Cluster Headache Tracker is a free, open-source web application designed to help individuals suffering from cluster headaches track and manage their condition. By providing detailed logging, visual insights, and easy sharing with healthcare providers, this tool aims to improve the understanding and treatment of cluster headaches.
- Host: GitHub
- URL: https://github.com/crmne/cluster-headache-tracker
- Owner: crmne
- License: gpl-3.0
- Created: 2024-08-13T07:36:05.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-26T15:50:46.000Z (17 days ago)
- Last Synced: 2025-01-26T16:31:34.899Z (17 days ago)
- Topics: cluster-headache, health, rails, ruby
- Language: HTML
- Homepage: https://clusterheadachetracker.com
- Size: 15.5 MB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 🧠 Cluster Headache Tracker
Cluster Headache Tracker is a free, open-source web application designed to help individuals suffering from cluster headaches track and manage their condition. By providing detailed logging, visual insights, and easy sharing with healthcare providers, this tool aims to improve the understanding and treatment of cluster headaches.
## 💝 Support the Project
If you find Cluster Headache Tracker helpful in managing your condition, please consider supporting its development:
[](https://buymeacoffee.com/crmne)
Your support helps keep this tool free and continuously improving for the cluster headache community.
## 🎥 Demo
[](https://youtu.be/4HlsqANZdv8)
## 🚀 Getting Started
Visit [https://clusterheadachetracker.com](https://clusterheadachetracker.com) to create a free account and start tracking your cluster headaches.
## 📱 Mobile Apps
### iOS App (Beta)
We have a beta version of our iOS app available through TestFlight! This native app provides the best possible experience for iOS users.
- [Download the iOS Beta App](https://testflight.apple.com/join/GJsAQqz2)
- [Contribute to the iOS Beta App](https://github.com/crmne/cluster-headache-tracker-ios)
### Android App (Beta)
The Beta Android app is available for direct download from our website:
- [Download the Android Beta App](https://clusterheadachetracker.com/cluster-headache-tracker.apk)
- [Contribute to the Android Beta App](https://github.com/crmne/cluster-headache-tracker-android)
Both apps provide the same features as the web application in a native mobile interface:
- Quick logging during attacks
- Automatic time filling
- Real-time attack duration tracking
- Charts and statistics
- Easy sharing with doctors
## ✨ Features
- 📝 **Smart Logging**: Auto-fills current time, just slide for intensity during attacks
- ⏱️ **Attack Tracking**: Real-time duration timer for ongoing attacks
- 📊 **Visual Insights**: Interactive charts showing attack patterns and predicting cluster period endings
- 🩺 **Doctor's View**: Generate shareable reports that have helped many users get oxygen therapy approved
- 💾 **Data Import/Export**: Easy CSV import/export for backup or analysis
- 🔒 **Secure & Private**: Encrypted data stored in Germany, no email required
- 🇪🇺 **EU-Based**: Full compliance with strict EU data protection regulations
- 📱 **Native Apps**: Dedicated apps for iOS and Android
- 🌟 **Open Source**: Free forever, community-driven development
## 💻 Development Setup
### Prerequisites
- Ruby 3.3.4
- PostgreSQL
- Node.js
### Setup Instructions
1. Clone the repository:
```
git clone https://github.com/crmne/cluster-headache-tracker.git
cd cluster-headache-tracker
```
2. Install dependencies:
```
bundle install
npm install
```
3. Set up the database:
```
rails db:create
rails db:migrate
```
4. Set up environment variables:
Create a `.env` file in the root directory and add the following variables:
```
RAILS_MASTER_KEY=your_master_key
POSTGRES_PASSWORD=your_database_password
HONEYBADGER_API_KEY=your_honeybadger_api_key
```
5. Start the development server:
```
bin/dev
```
6. Visit `http://localhost:3000` in your browser to see the application running locally.
## 🧪 Running Tests
To run the test suite:
```
rails test
rails test:system
```
## 🚢 Deployment
This project uses Kamal for deployment. To deploy:
1. Set up your deployment configuration in `config/deploy.yml`.
2. Run:
```
kamal deploy
```
## 🤝 Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details on how to get started.
## 📄 License
Cluster Headache Tracker is released under the [GNU General Public License v3.0 (GPL-3.0)](LICENSE).
## 🔒 Privacy
We take your privacy seriously. Cluster Headache Tracker does not collect or store any personally identifiable information. Users are identified by a username only, not an email address. All data is stored on servers located in Germany, ensuring compliance with strict EU data protection regulations.
## 🆘 Support
If you encounter any issues or have questions, please [open an issue](https://github.com/crmne/cluster_headache_tracker/issues) on GitHub.
## 🙏 Acknowledgements
Thank you to all the contributors and users who help make this project better every day.