Chronosight/README.md

Chronosight

English | 简体中文

Understand your digital habits with Chronosight, a cross-platform screen time tracking and analysis application.

Gain valuable insights into how you spend your time on your devices. Chronosight helps you track your screen time, analyze your app usage, and ultimately promotes better digital well-being across your phone, tablet, and computer.

Key Features

• Cross-Platform Tracking: Seamlessly track your screen time on Android, iOS, and desktop (macOS, Windows, Linux).
• Detailed Usage Analysis: Get a breakdown of your app usage, including time spent per app and usage patterns.
• Digital Well-being Insights: Understand your digital habits and identify areas for potential improvement.
• Shared State]: Optionally share your usage statistics with friends or across your own devices for a holistic view.
• Customizable Reports: Generate customizable reports to analyze your screen time data over specific periods.

Technology Stack

Chronosight is built with the following technologies:

• Kotlin Multiplatform Mobile (KMM): Powers the core business logic, data analysis, and shared functionality across all platforms.
• Android: Native UI development using Kotlin and Jetpack Compose.
• iOS: Native UI development using Swift and SwiftUI.
• Desktop: Compose for Desktop.
• Backend: Ktor for user authentication, data syncing and shared state functionality.

Platform Support

Chronosight is currently targeting the following platforms:

• 📱 Mobile: Android, iOS
• 💻 Desktop: macOS, Windows, Linux

Getting Started (For Developers)

If you're interested in contributing or building the project yourself, here's a quick guide:

1. Prerequisites: Ensure you have the necessary SDKs and development environments set up for Android, iOS, and Desktop Kotlin development.
2. Clone the Repository: git clone https://github.com/grtsinry43/Chronosight.git
3. Open project: Open the project in IntelliJ IDEA (or Android Studio).
4. Build and Run:

• Android: Run the androidApp module.
• iOS: Open the iosApp/iosApp.xcodeproj in Xcode and run.
• Desktop: Run the desktopApp module.

Screenshots

Contributing

License

More

This is a Kotlin Multiplatform project targeting Android, iOS, Desktop.

• /composeApp is for code that will be shared across your Compose Multiplatform applications. It contains several subfolders:

  • commonMain is for code that’s common for all targets.
  • Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name. For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app, iosMain would be the right folder for such calls.

• /iosApp contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform, you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.

• /shared is for the code that will be shared between all targets in the project. The most important subfolder is commonMain. If preferred, you can add code to the platform-specific folders here too.

Learn more about Kotlin Multiplatform…