diff --git a/README.md b/README.md index b8c2faf..f67990f 100644 --- a/README.md +++ b/README.md @@ -36,15 +36,15 @@ ## About The Project -Stay aware of your cycle without sacrificing your privacy. Ephira is a secure period-tracker that keeps your data encrypted locally on your device. +Stay aware of your cycle without sacrificing your privacy. Ephira is a secure period tracker that keeps your data encrypted locally on your device. -Track Your Health: Log menstrual flow, symptoms, moods, medications, birth control, and notes. +**Track Your Health:** Log menstrual flow, symptoms, moods, medications, birth control, and notes. -Privacy First: Data is encrypted and never leaves your device. It can be locked behind biometrics (Face ID/Fingerprint) or a custom password, and can be deleted at any time. +**Privacy First:** Data is encrypted and never leaves your device. It can be locked behind biometrics (Face ID/Fingerprint) or a custom password, and can be deleted at any time. -Open and Transparent: Ephira is open source under the MIT license, and you can review the code at any time on Github. +**Open and Transparent:** Ephira is open source under the MIT license, and you can review the code at any time on GitHub. - + ## Key Features @@ -52,20 +52,73 @@ Open and Transparent: Ephira is open source under the MIT license, and you can r Add and track custom symptoms, moods, medications, and more with a smooth, visual calendar interface. Filter your calendar legend to only show the symptoms, moods, and medications you want to see. This makes it easy to focus on the data that matters most to you. -‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ +\u200E \u200E \u200E \u200E \u200E \u200E \u200E \u200E \u200E + +### Cycle Insights & Predictions + +The Cycle tab gives you a personalized view of your menstrual health. Once you've logged enough data, Ephira provides: + +- **Current cycle status** — where you are in your cycle today +- **Phase tracking** — follicular, ovulation, luteal, and menstrual phases with wellness context +- **Cycle predictions** — predicted period start dates based on your logged history +- **Cycle statistics** — average cycle length, period duration, and historical trends +- **Wellness tips** — phase-specific suggestions tailored to your current cycle stage + +Predictions require at least 2 complete cycles and can be toggled on or off in Settings. ### App Locking with Passcode & Biometrics -Protect your data with Face ID or a custom password unique to Ephira. +Protect your data with Face ID, fingerprint, or a custom password unique to Ephira. ![Password Demo (Final-All)](https://github.com/user-attachments/assets/296864e6-ae4e-48ac-8ee8-b9ca0cd0f9e9) +### Data Export + +Export your full health history as a PDF at any time from the Settings screen. Your data stays yours — you can take it with you or share it with a healthcare provider. + +### Color Themes + +Choose from multiple color themes to personalize the look and feel of the app. Themes apply across the entire interface. + +### Birth Control Tracking + +Log and track birth control alongside your other health data. Configure your birth control type in Settings to keep everything in one place. + +### Notifications + +Set up reminders to log your data or be notified about upcoming predicted periods. + +### Guided Onboarding & Walkthrough + +A step-by-step walkthrough helps new users get set up quickly. The walkthrough can be replayed at any time from Settings. + + + ## License [![License][license-shield]][license-url] See `LICENSE.txt` for more information. + + +## Contributing + +We welcome contributions! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on branching, commits, pull requests, and code quality standards. + +**Quick start:** + +```bash +git clone https://github.com/adulbrich/ephira.git +cd ephira +npm install +npx expo start +``` + +See [PROJECTSTRUCTURE.md](PROJECTSTRUCTURE.md) for an overview of the codebase, key libraries, and local setup instructions. + +> **Note:** Due to using Expo SQLite, the app only runs on physical devices or emulators (not Expo web). + ## Acknowledgments @@ -85,12 +138,6 @@ See `LICENSE.txt` for more information. [Minion Variable Concept](https://fonts.adobe.com/fonts/minion) - - -## Getting Started - -Check out the [Project Structure](https://github.com/adulbrich/ephira/blob/main/PROJECTSTRUCTURE.md) document for an overview of the key components of the app, main libraries used, and how to set up the app locally. - diff --git a/docs/src/pages/index.astro b/docs/src/pages/index.astro index 930c9a0..8cdab6e 100644 --- a/docs/src/pages/index.astro +++ b/docs/src/pages/index.astro @@ -77,7 +77,7 @@ import googlePlayBadge from "../assets/google-play-badge.png";

Project Overview

- Ephira is a local-only, open-source menstrual tracking app designed to prioritize user privacy and data security. It allows users to track their reproductive health without exposing sensitive data to cloud-based platforms or third parties. While there are many privacy-focused menstrual tracking apps out there, many back data up in the cloud or aren't open source. + Ephira is a local-only, open-source menstrual tracking app designed to prioritize user privacy and data security. It allows users to track their reproductive health without exposing sensitive data to cloud-based platforms or third parties. While there are many privacy-focused menstrual tracking apps out there, many back data up in the cloud or aren't open source.

Tech Stack & Implementation

@@ -93,7 +93,7 @@ import googlePlayBadge from "../assets/google-play-badge.png";

App Locking with Passcode & Biometrics

-

Protect your data with Face ID or a custom password unique to Ephira.

+

Protect your data with Face ID, fingerprint, or a custom password unique to Ephira. No account needed — your lock is local to your device.

@@ -101,7 +101,7 @@ import googlePlayBadge from "../assets/google-play-badge.png";

Customizable Calendar & Symptom Tracking

-

Add and track custom symptoms, moods, medications, and more with a smooth, visual calendar interface.

+

Log menstrual flow, symptoms, moods, medications, birth control, and notes. Add your own custom entries and track exactly what matters to you with a smooth, visual calendar interface.

@@ -115,12 +115,34 @@ import googlePlayBadge from "../assets/google-play-badge.png";
+
+

Cycle Insights & Predictions

+

The Cycle tab gives you a personalized view of your menstrual health. Track your current phase — follicular, ovulation, luteal, or menstrual — and get predicted period start dates based on your logged history. View cycle statistics like average length and duration, and receive phase-specific wellness tips. Predictions kick in after 2 complete cycles and can be toggled on or off in Settings.

+
+ +
+ Cycle insights demo coming soon +
+
+ +

Custom Themes & Color Schemes

-

Personalize your app with six different themes and light/dark mode support based on your device settings.

+

Personalize your app with multiple themes and light/dark mode support based on your device settings.

Color Scheme Demo
- + +
+
+

Data Export

+

Export your full health history as a PDF at any time from the Settings screen. Your data stays yours — take it with you or share it with a healthcare provider.

+
+ +
+ Data export demo coming soon +
+
+