Skip to content

Demiserular/MENTY

BranchesTags

Repository files navigation

MENTY 🧠

The local diary - A privacy-first mental health companion app built with React Native and Expo.

📱 About

Menty is a comprehensive mental health tracking and journaling app that keeps all your data locally on your device. No cloud syncing, no data collection - just you and your thoughts, secured with device-level encryption and biometric authentication.

Key Features

  • 🔒 Privacy-First: All data stored locally with encryption
  • 👆 Biometric Security: Face ID, Touch ID, and Fingerprint support
  • 😊 Mood Tracking: Track your daily mood with emoji slider and emotion tags
  • 📝 CBT Journal: Guided Cognitive Behavioral Therapy journaling with 7-step process
  • 🫁 Breathing Exercises: Multiple breathing techniques (4-7-8, Box Breathing, etc.)
  • 🆘 Crisis Support: Grounding exercises and safety planning tools
  • 🎨 Beautiful UI: Glassmorphic design with smooth animations
  • ♿ Accessible: VoiceOver/TalkBack support and dynamic text scaling

🚀 Getting Started

Prerequisites

  • Node.js 20.18.0 or higher
  • npm or yarn
  • Expo Go app (for quick testing)
  • Expo account (for EAS builds)

Installation

  1. Clone the repository

    git clone https://github.com/Demiserular/MENTY.git
cd MENTY

  2. Install dependencies

    npm install

  3. Start the development server

    npm start

  4. Run on your device

    • Scan the QR code with Expo Go (iOS/Android)
    • Or press i for iOS Simulator
    • Or press a for Android Emulator

📖 Usage Guide

First Time Setup

  1. Create a PIN: Set up a 6-digit PIN to secure your data
  2. Optional Biometrics: Navigate to Settings → Security → Biometric Setup
  3. Start Journaling: Use the bottom navigation to explore features

Daily Workflow

  1. Check In: Tap "Mood" to log how you're feeling
  2. Journal: Write in the free-form journal or use CBT prompts
  3. Breathe: Take a moment with guided breathing exercises
  4. Reflect: Review your mood trends on the Home screen

Biometric Authentication

In Expo Go:

  • Simulated experience for testing
  • Use "Test Biometric Auth" button in settings

In EAS Builds:

  • Real Face ID/Touch ID/Fingerprint
  • Automatic prompts on app launch
  • Settings → Security → Biometric Setup to enable/disable

🛠️ Development

Project Structure

Menty/
├── src/
│   ├── components/      # Reusable UI components
│   │   ├── GlassCard.tsx
│   │   ├── GlassButton.tsx
│   │   └── ...
│   ├── screens/         # App screens
│   │   ├── HomeScreen.tsx
│   │   ├── MoodCheckinScreen.tsx
│   │   ├── CBTJournalScreen.tsx
│   │   └── ...
│   ├── navigation/      # Navigation setup
│   ├── services/        # Core services
│   │   ├── db.ts       # SQLite database
│   │   └── secure.ts   # Encryption & biometrics
│   ├── theme/          # Theme and styling
│   ├── types/          # TypeScript types
│   └── hooks/          # Custom React hooks
├── assets/             # Images, fonts, etc.
├── docs/              # Documentation (gitignored)
└── app.json           # Expo configuration

Key Technologies

  • React Native 0.81.5 - Mobile framework
  • Expo SDK 54 - Development platform
  • TypeScript - Type safety
  • SQLite - Local database
  • Expo SecureStore - Encrypted storage
  • react-native-biometrics - Biometric authentication
  • react-native-reanimated - Smooth animations (EAS builds only)

Running Tests

npm test

Linting & Formatting

# Run linter
npx eslint .

# Format code
npm run prettier

🏗️ Building for Production

EAS Build (Recommended)

  1. Install EAS CLI

    npm install -g eas-cli

  2. Login to Expo

    eas login

  3. Build for Development

    # iOS
eas build --platform ios --profile development

# Android
eas build --platform android --profile development

  4. Build for Production

    eas build --platform all --profile production

Why EAS Build?

  • Real Biometrics: Native Face ID/Touch ID/Fingerprint
  • Smooth Animations: Full react-native-reanimated support
  • Better Performance: Native compilation
  • App Store Ready: Production-ready builds

🤝 Contributing

We welcome contributions! Here's how to get started:

Making Changes

  1. Fork the repository

    # Click "Fork" on GitHub, then:
git clone https://github.com/YOUR_USERNAME/MENTY.git
cd MENTY

  2. Create a feature branch

    git checkout -b feature/your-feature-name

  3. Make your changes

    • Follow existing code style
    • Add comments for complex logic
    • Test on both iOS and Android if possible

  4. Commit your changes

    git add .
git commit -m "Add: Brief description of your changes"

  5. Push to your fork

    git push origin feature/your-feature-name

  6. Create a Pull Request

    • Go to the original repository on GitHub
    • Click "New Pull Request"
    • Select your branch and describe your changes

Commit Message Convention

  • Add: New feature or file
  • Fix: Bug fix
  • Update: Modify existing feature
  • Refactor: Code restructuring
  • Docs: Documentation changes
  • Style: Code formatting
  • Test: Add or modify tests

Code Style Guidelines

  • Use TypeScript for all new code
  • Follow existing component patterns
  • Use functional components with hooks
  • Keep components small and focused
  • Add accessibility labels to interactive elements
  • Test in Expo Go before creating PR

📋 Roadmap

Completed ✅

  • Core mood tracking
  • CBT journaling
  • Breathing exercises
  • Crisis support tools
  • Biometric authentication
  • Data encryption
  • Glassmorphic UI

Planned 🚧

  • Data export (JSON/PDF)
  • Encrypted cloud backup (optional)
  • Mood prediction ML model
  • Voice notes
  • Custom breathing patterns
  • Habit tracking
  • Therapist sharing mode
  • Dark/Light theme toggle

🔐 Security & Privacy

Data Storage

  • All data encrypted with AES-256
  • Master key stored in device keychain
  • No network requests
  • No analytics or tracking
  • No third-party SDKs with data collection

Biometric Security

  • Uses device's native biometric APIs
  • Biometric data never leaves the device
  • Optional - you can use PIN only
  • Can be enabled/disabled anytime

Secure Deletion

  • 3-step confirmation process
  • Overwrites encrypted data
  • Clears all storage locations
  • Cannot be recovered after deletion

🐛 Known Issues

Expo Go Limitations

  • Animations disabled: react-native-reanimated conflicts with Expo Go's built-in version
  • Biometrics simulated: Real biometrics only work in EAS builds
  • Solution: Use EAS development builds for full experience

Troubleshooting

"Worklets mismatch" error:

  • This is normal in Expo Go
  • Animations are disabled for compatibility
  • Build with EAS for animations

Biometrics not working:

  • Ensure you're using an EAS build
  • Check device has biometrics enabled
  • Verify permissions in Settings

App crashes on startup:

  • Clear Expo Go cache: Settings → Clear cache
  • Restart Metro bundler: npx expo start -c
  • Reinstall dependencies: rm -rf node_modules && npm install

📄 License

MIT License

Copyright (c) 2025 Menty

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

💬 Support

🙏 Acknowledgments

  • Built with Expo
  • Inspired by evidence-based mental health practices
  • CBT techniques based on cognitive behavioral therapy principles
  • Breathing exercises from established wellness practices

Note: This app is not a replacement for professional mental health care. If you're experiencing a mental health crisis, please contact a mental health professional or crisis hotline immediately.

Crisis Resources:

  • US: 988 Suicide & Crisis Lifeline
  • UK: 116 123 (Samaritans)
  • International: findahelpline.com

About

The local diary

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages