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://clusterheadachetracker.com
GNU General Public License v3.0
12 stars 2 forks source link
cluster-headache health rails ruby

๐Ÿง  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:

Buy me a pizza

Your support helps keep this tool free and continuously improving for the cluster headache community.

๐ŸŽฅ Demo

Cluster Headache Tracker Demo

๐Ÿš€ Getting Started

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

Android App (Beta)

The Beta Android app is available for direct download from our website:

Both apps provide the same features as the web application in a native mobile interface:

โœจ Features

๐Ÿ’ป Development Setup

Prerequisites

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

๐Ÿ”’ 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 on GitHub.

๐Ÿ™ Acknowledgements

Thank you to all the contributors and users who help make this project better every day.