Skip to content

V-Mugisha/MindMate-Python_Summative-Cohort1_Group7

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MindMate - Simple Mental Wellness Tracker

A CLI-based mental wellness tracker designed to help students manage stress through daily check-ins, breathing exercises, and gratitude journaling.

Features

  • Daily Stress Check-In: Rate your stress level (1-10) with personalized feedback
  • Guided Breathing Exercise: Simple 4-second breathing cycles for relaxation
  • Gratitude Journal: Write daily gratitude entries with helpful prompts
  • Wellness History: View your past entries and progress
  • Weekly Summary: Get insights and recommendations based on your data

Installation & Setup

  1. Make sure you have Python 3.6+ installed

  2. Download all 4 Python files:

    • main.py (entry point)
    • database.py (database operations)
    • wellness.py (core features)
    • analytics.py (reporting)
  3. Run the application:

    python3 main.py

File Structure

MindMate-Python_Summative-Cohort1_Group7/
├── main.py          # Application entry point and menu system
├── database.py      # SQLite database setup and operations
├── wellness.py      # Stress tracking, breathing, and journaling
├── analytics.py     # History viewing and weekly summaries
├── README.md        # This dicumentation file
└── mindmate.db      # SQLite database (created and generated automatically)

How to Use

  1. First Run: Enter a username to create your account
  2. Daily Check-In: Record your stress level (1-10)
  3. Breathing Exercise: Follow the guided 4-cycle breathing session
  4. Journal Entry: Write about something you're grateful for
  5. View History: See your past entries and progress
  6. Weekly Summary: Get insights about your wellness trends

Database Schema

Users Table

  • id: Primary key
  • username: Unique username (you can also use your name)
  • created_at: Account creation timestamp

Daily Entries Table

  • id: Primary key
  • user_id: Foreign key to users
  • entry_date: Date of entry
  • stress_level: Stress rating (1-10)
  • journal_text: Gratitude journal entry
  • breathing_completed: Boolean for breathing exercise
  • created_at: Entry creation timestamp

Quotes Table

  • id: Primary key
  • quote_text: Motivational quote text
  • author: Quote author

Sample Usage Flow

  1. Login/Register: python3 main.py
  2. Daily Routine:
    • Check stress level → Get personalized feedback
    • Do breathing exercise → Feel more relaxed
    • Write gratitude entry → Practice mindfulness
  3. Track Progress:
    • View history → See your wellness journey
    • Weekly summary → Get insights and recommendations

Key Benefits

  • Simple & Accessible: No complex setup or internet required
  • Privacy-Focused: All data stored locally in SQLite database
  • Evidence-Based: Features based on proven wellness practices
  • Student-Friendly: Quick daily activities that fit busy schedules
  • Progress Tracking: Visual feedback on wellness trends

Technical Notes

  • Built with Python 3 and SQLite3 (no external dependencies)
  • Cross-platform compatible (Windows, Mac, Linux)
  • Terminal-based interface for simplicity
  • Automatic database creation and management
  • Input validation and error handling

Future Enhancements

  • Mood trend visualization
  • Reminder notifications
  • Multiple breathing exercise types
  • Goal setting and achievements

Support

This is an educational project designed for academic purposes. For issues or questions, refer to the source code comments and documentation.


MindMate - Taking care of your mental health, one day at a time! 🌟

About

MindMate is a CLI-based mental wellness tracker targeting the Health & Wellness GCGO, designed to help students manage stress through daily check-ins, breathing exercises, and gratitude journaling.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages