![Flutter](https://img.shields.io/badge/Flutter-%2302569B.svg?style=for-the-badge&logo=Flutter&logoColor=white)

[![Crowdin](https://badges.crowdin.net/menstrudel/localized.svg)](https://crowdin.com/project/menstrudel) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=J-shw_Menstrudel&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=J-shw_Menstrudel) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=J-shw_Menstrudel&metric=coverage)](https://sonarcloud.io/summary/new_code?id=J-shw_Menstrudel) [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=J-shw_Menstrudel&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=J-shw_Menstrudel) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=J-shw_Menstrudel&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=J-shw_Menstrudel) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=J-shw_Menstrudel&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=J-shw_Menstrudel)

<br>

<div align="center">

  <img src="icon/menstrudel.png" alt="Menstrudel App Icon" style="width: 120px;">

  # Menstrudel

  **Your Cycle & Pill Companion**

  <p>A free, private, and open-source period & pill tracking app for Android and iOS.</p>

  <p>
    <a href="https://github.com/J-shw/Menstrudel">
      <img src="https://img.shields.io/github/stars/J-shw/Menstrudel?style=social" alt="GitHub stars">
    </a>
  </p>

  [![Discord](https://img.shields.io/discord/1429146104448155668?color=7389D8&label=&logo=discord&logoColor=ffffff)](https://discord.gg/jWrH9DvACS)

  <div>
    <a href="https://play.google.com/store/apps/details?id=com.whitticase.menstrudel"><img src="icon/stores/playstore-en.svg" alt="Play Store" width="120"></a>
    <a href="https://apps.apple.com/us/app/menstrudel/id6751970511"><img src="icon/stores/appstore-en.svg" alt="App Store" width="120"></a>
  </div>
</div>

<br>

## Get Involved

- 🌐 **Translators:** [Help translate](https://crowdin.com/project/menstrudel)

- 💬 **Community:** [Join our official Discord Server](https://discord.gg/jWrH9DvACS)

<br>

## About Menstrudel

Menstrudel is a simple, private, and intuitive mobile application built with Flutter to help you track your menstrual cycle. Log your period start dates, record symptoms and flow intensity, and get predictions for your next cycle. Designed with privacy in mind, all your personal health data is stored securely offline on your device.

<br>

## Key Features

Take control of your menstrual health with an intuitive, private, and powerful tracker. Designed to be your all-in-one companion, it helps you understand your body, stay on top of your regimen, and anticipate your cycle with confidence.

### Smart Cycle Tracking 🩸
* **Log with a Tap:** Effortlessly record your periods.
* **Discover Your Patterns:** Track flow, pain, and symptoms to learn more about your body's unique rhythm.
* **See Your History:** A clear journal of your entire menstrual history, right at your fingertips.

### Predictive Insights 📊
* **Stay Prepared, Never Surprised:** Get accurate, forecasts for your next period based on your personal history.
* **Know Your Flow:** Understand your average cycle length and variations.
* **Visual Countdown:** A clean, simple countdown keeps you informed about when your next cycle is expected to begin.

### Effortless Pill Management 💊
* **Flexible Setup:** Easily customise your specific pill pack, whether it’s a 21/7, 28-day, or any other regimen.
* **Build Your Streak:** Log your daily intake with a single tap and track your adherence over time.

### LARC Tracking and Reminders 🗓️
* **Never Miss a Beat:** Log LARC usage, and track renewal dates with notification alerts.
* **Stay Informed:** Get timely, customisable notifications for upcoming device expiry.

### Timely & Customizable Reminders ⏰
* **Period Alerts:** Get a gentle heads-up a few days before your period is due.
* **Pill Reminders:** Never miss a pill with consistent daily notifications tailored to your schedule.
* **Hygiene Reminders:** For your health and safety, set discreet reminders to change your sanitary product.

### Absolute Privacy & Security 🔒
* **Your Data, Your Device:** All your sensitive health information is stored securely and exclusively on your phone using SQLite.
* **No Accounts, No Clouds:** Your privacy is our priority. No sign-ups, and your data never leaves your device.

### Beautifully Your Own ☀️/🌙
* **Stunning Themes:** Seamlessly switches between Light and Dark mode to match your system's theme.
* **Clutter-Free Design:** A clean, intuitive interface designed to be a pleasure to use every day.

<br>

## Privacy Policy

You can view our privacy policy [here](https://menstrudel.app/privacy/).

<br>

## Socials

- [Website](https://menstrudel.app/)
- [Discord](https://discord.gg/jWrH9DvACS)
- [ItsAllWidgets](https://itsallwidgets.com/menstrudel)
- [AlternativeTo](https://alternativeto.net/software/menstrudel/about/)

<br>

# App Screenshots

<table width="100%">
  <tr>
    <td width="25%" align="center"><b>Today screen</b></td>
    <td width="25%" align="center"><b>Quick log entry</b></td>
    <td width="25%" align="center"><b>Log calendar</b></td>
    <td width="25%" align="center"><b>Log insights</b></td>
  </tr>
  <tr>
    <td><img src="docs/screenshots/android/logs_today_screen.png" width="100%"></td>
    <td><img src="docs/screenshots/android/logs_add_log_screen.png" width="100%"></td>
    <td><img src="docs/screenshots/android/logs_calendar_screen.png" width="100%"></td>
    <td><img src="docs/screenshots/android/logs_insights_screen.png" width="100%"></td>
  </tr>
  <tr>
    <td align="center"><b>Sanitary product reminder</b></td>
    <td align="center"><b>Sanitary product insights</b></td>
    <td align="center"><b>Pill reminders</b></td>
    <td align="center"><b>Settings</b></td>
  </tr>
  <tr>
    <td><img src="docs/screenshots/android/sanitary_product_log_screen.png" width="100%"></td>
    <td><img src="docs/screenshots/android/sanitary_product_insight_screen.png" width="100%"></td>
    <td><img src="docs/screenshots/android/pill_screen.png" width="100%"></td>
    <td><img src="docs/screenshots/android/settings_screen.png" width="100%"></td>
  </tr>
  <tr>
    <td align="center"><b>Reversible contraceptives</b></td>
    <td align="center"><b>Sex logging</b></td>
    <td align="center"><b>Sex insights</b></td>
    <td align="center"><b>Widgets</b></td>
  </tr>
  <tr>
    <td><img src="docs/screenshots/android/contraceptives_screen.png" width="100%"></td>
    <td><img src="docs/screenshots/android/sex_activity_log_screen.png" width="100%"></td>
    <td><img src="docs/screenshots/android/sex_activity_insight_screen.png" width="100%"></td>
    <td><img src="docs/screenshots/android/widget_screen.png" width="100%"></td>
  </tr>
</table>

# Wear OS

| Prediction View | Quick logging |
| :---: | :---: |
| ![Log View](docs/screenshots/wearos/logs_screen.webp) | ![Symptom Entry Dialog](docs/screenshots/wearos/log_screen.webp) | 


# Star History


[![Star History Chart](https://api.star-history.com/chart?repos=J-shw/Menstrudel&type=date&legend=top-left&sealed_token=ZmvOkLGUxAazJckzS1ZToc7nzzlM-L7cXc6bZVYupHfpADbytTpqCwufsx8npmRhn2NRXEscqu8iwwDKOoPmLjxAzLbF0ddvPE-TEMSh0BFsfBZJH0Fhv6e3nvOe2O3j5XeK6Cy2ai6SD4BrmUbOn9enYYdOXREWToD580FrY1sMA-sKqMVLlELmaF5t)](https://www.star-history.com/?repos=J-shw%2FMenstrudel&type=date&legend=top-left)