A privacy-first mental health companion that helps you track your wellness journey, manage medications, and find emotional support.
Your data stays on your device. Always.
PinkRain is a comprehensive mental health and wellness tracking application designed with privacy at its core. Unlike other health apps, all your data remains securely stored on your device and never leaves your phone. The app combines mood tracking, medication management, guided meditation, and AI-powered symptom prediction to provide a holistic approach to mental wellness.
⚠️ IMPORTANT DISCLAIMER: This is an experimental research project made open source for educational and development purposes. This app is NOT a medical device and does not claim to improve your mental or physical health in any way. It should NEVER be considered a replacement for professional healthcare providers, licensed therapists, psychiatrists, or medical professionals. Always consult with qualified healthcare providers for medical advice, diagnosis, or treatment.
- 🔒 Privacy First: Zero data collection - everything stays on your device
- 🧠 AI-Powered: Smart symptom prediction using TensorFlow Lite
- 💊 Medication Tracking: Never miss a dose with smart notifications
- 📊 Wellness Insights: Beautiful charts and correlation analysis
- 🎵 Emotional Support: Curated audio content for healing
- 📱 Cross-Platform: Built with Flutter for iOS and Android
- Daily mood logging with rich descriptions
- Symptom tracking with AI-powered predictions
- Correlation analysis between mood, symptoms, and medications
- Beautiful visualizations and trends
- Comprehensive medication database with custom dosages
- Smart notification system with snooze and mark-taken actions
- Adherence tracking and reports
- Visual pill identification
- Curated healing audio tracks:
- "The Voice You Needed"
- "You're Not a Burden"
- "What You Feel is Real"
- "When You Miss Who You Used to Be"
- And more...
- Breathing exercises with visual guidance
- Mindfulness sessions
- Interactive charts showing mood patterns
- Medication adherence statistics
- Symptom correlation analysis
- PDF report generation for healthcare providers
- Data export functionality
- TensorFlow Lite model for symptom prediction
- Personalized wellness recommendations
- Pattern recognition in mood and symptoms
- Medication reminders with action buttons
- Daily mood check-ins
- Wellness insights notifications
- Customizable notification sounds
- Flutter 3.3.4 or higher
- Dart 3.0 or higher
- Android Studio / VS Code
- Git
-
Clone the repository
git clone https://github.com/rudi-q/pinkrain_health_journal.git cd pinkrain_health_journal -
Install dependencies
flutter pub get
-
Run the app
flutter run
PinkRain includes experimental AI-powered symptom prediction using TensorFlow Lite. This feature is disabled by default but can be enabled for testing and research purposes.
Enable Experimental Symptom Prediction:
# Development
flutter run --dart-define=EXPERIMENTAL=true
# Release builds
flutter build apk --release --dart-define=EXPERIMENTAL=true
flutter build appbundle --release --dart-define=EXPERIMENTAL=true
flutter build ios --release --dart-define=EXPERIMENTAL=trueDefault Mode (Symptom Prediction Disabled):
# These commands run without experimental features
flutter run
flutter build apk --release
flutter build appbundle --release
flutter build ios --releaseNote: When experimental mode is disabled, the app functions normally but the AI symptom prediction feature is not available. The TensorFlow Lite model files (~12MB) are still included in the app bundle but are not loaded into memory.
Web Platform: Experimental features like symptom prediction are automatically disabled on web platforms regardless of the
EXPERIMENTALflag setting, as TensorFlow Lite is not supported in web browsers. The app will use mock implementations for web compatibility.
Standard Release (No Experimental Features):
flutter build apk --release
# or
flutter build appbundle --releaseExperimental Release (With AI Symptom Prediction):
flutter build apk --release --dart-define=EXPERIMENTAL=true
# or
flutter build appbundle --release --dart-define=EXPERIMENTAL=trueiOS:
flutter build ios --release
# or with experimental features
flutter build ios --release --dart-define=EXPERIMENTAL=truePinkRain follows clean architecture principles with clear separation of concerns:
lib/
├── core/
│ ├── models/ # Data models
│ ├── services/ # Core services (Hive, Navigation)
│ ├── theme/ # App theming
│ ├── util/ # Utilities and helpers
│ └── widgets/ # Reusable widgets
├── features/
│ ├── journal/ # Mood tracking and journaling
│ ├── pillbox/ # Medication management
│ ├── wellness/ # Analytics and insights
│ ├── breathing/ # Breathing exercises
│ ├── meditation/ # Guided meditation
│ └── profile/ # User settings
└── main.dart
- State Management: Riverpod
- Local Database: Hive (NoSQL)
- AI/ML: TensorFlow Lite
- Charts: FL Chart
- Audio: Just Audio
- Notifications: Flutter Local Notifications
- PDF Generation: PDF package
- Navigation: Go Router
PinkRain includes comprehensive testing:
# Run all tests
flutter test
# Run integration tests
flutter drive --target=integration_test/app_test.dart
# Run specific test files
flutter test test/features/journal/- Unit tests for business logic
- Widget tests for UI components
- Integration tests for user flows
- Notification action testing
We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated.
- Fork the repository
- Create a feature branch
git checkout -b feature/amazing-feature
- Make your changes
- Add tests for new functionality
- Run tests and ensure they pass
flutter test - Commit your changes
git commit -m "Add amazing feature" - Push to your branch
git push origin feature/amazing-feature
- Open a Pull Request
- Follow Flutter style guide
- Write tests for new features
- Update documentation as needed
- Ensure privacy-first principles are maintained
- 🌐 Internationalization: Help translate the app
- 🎨 UI/UX: Improve accessibility and user experience
- 🧪 Testing: Add more test coverage
- 📚 Documentation: Improve guides and tutorials
- 🤖 AI/ML: Enhance symptom prediction models
- No data collection: All data remains on your device
- No analytics tracking: We don't track user behavior
- No cloud sync: Data never leaves your device
- Open source: Full transparency in code
- Local encryption for sensitive data
- Secure local notifications
- No network requests for personal data
- Privacy-focused third-party dependencies
This application is an experimental research project developed for educational, research, and open-source development purposes. It is made available to the community to advance understanding of mental health tracking technologies and privacy-preserving app development.
IMPORTANT: This app is NOT:
- A medical device or diagnostic tool
- A substitute for professional medical advice, diagnosis, or treatment
- Intended to cure, treat, prevent, or diagnose any medical condition
- A replacement for therapy, counseling, or psychiatric care
- Clinically validated or FDA-approved
ALWAYS consult with qualified healthcare professionals including but not limited to:
- Licensed physicians and psychiatrists
- Licensed therapists and counselors
- Certified mental health professionals
- Your primary care provider
Before making any decisions about your mental health, medication, or treatment based on information from this app.
If you are experiencing a mental health emergency or crisis:
- Call emergency services immediately (911, 988 Suicide & Crisis Lifeline)
- Contact your local crisis intervention center
- Go to your nearest emergency room
- This app cannot and should not be used for emergency situations
By using this experimental research application, you acknowledge that:
- The developers, contributors, and maintainers assume no responsibility for any health outcomes
- All data and insights provided are for informational and research purposes only
- You use this application at your own risk
- Any decisions regarding your health should be made in consultation with qualified healthcare providers
This is a research project designed to:
- Explore privacy-preserving mental health tracking technologies
- Demonstrate on-device AI/ML capabilities
- Advance open-source mental health tools development
- All your data remains on your device and is never transmitted or collected
This project is licensed under the MIT License - see the LICENSE file for details.
Additional Terms: By using this software, you acknowledge that you have read and understood the Medical Disclaimer above and agree to use this experimental research application in accordance with these terms.
- Flutter Team for the amazing framework
- TensorFlow Lite for on-device ML capabilities
- Hive for fast local storage
- All contributors who help make PinkRain better
- Mental health advocates who inspire this work
Need help or have questions?
- 📧 Email: [email protected]
- 🐛 Bug Reports: GitHub Issues
- 💬 Discussions: GitHub Discussions
- Multi-language support
- Apple Health / Google Fit integration
- Enhanced AI models
- Accessibility improvements
- Desktop support
- Advanced analytics