SoberCheck

Note: No line of code in this project was written by a human. Everything, including this README, was generated by AI.

SoberCheck is a comprehensive, privacy-focused Android application designed to help users track their sobriety journey across multiple addictions or habits. It provides tools for logging cravings, visualizing progress, celebrating milestones, and managing emergency resources.

Features

• Multi-Addiction Tracking: Monitor multiple habits or addictions independently with custom start dates and priorities.
• Progress Visualization: View your sobriety time in real-time on the main dashboard.
• Detailed Logging:
  • Log cravings with intensity levels.
  • Record therapy sessions, social events, and relapses.
  • Add notes to entries for future reflection.
• Timeline: A dedicated screen to view your entire journey chronologically.
• Financial Tracker: Calculate and display total money saved based on daily expenditure settings.
• Milestones: Set target goals (days, weeks, months, years) and track your progress toward achieving them.
• Emergency Card: Quick access to:
  • Personal affirmations.
  • Coping skills.
  • Emergency contacts for immediate support.
• Gamification: Earn "Total Score" and rank up as you maintain your sobriety, providing extra motivation.
• Privacy & Security: All data is stored locally on your device.
• Modern UI: Built with Jetpack Compose following Material 3 guidelines, supporting both Light and Dark modes.

Tech Stack

• Language: Kotlin
• UI Framework: Jetpack Compose
• Architecture: MVVM with Repository pattern
• Dependency Injection: Hilt
• Local Database: Room
• Preferences: DataStore
• Navigation: Compose Navigation
• Background Tasks: WorkManager
• Serialization: Kotlinx Serialization

Getting Started

Prerequisites

• Android Studio Ladybug or newer.
• Android SDK 26+ (Minimum supported version).

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/SoberCheck.git

2. Open the project in Android Studio.
3. Sync the project with Gradle files.
4. Run the app on an emulator or a physical device.

Project Structure

• data/: Room database, entities, DAOs, and repository.
• ui/: Compose screens, view models, and UI components.
• di/: Hilt modules for dependency injection.
• notifications/: Notification logic and WorkManager workers.

License

This project is open-source. Please check back later for specific licensing information.