|
1 | | -This is a Kotlin Multiplatform project targeting Android, iOS, Web, Desktop (JVM). |
2 | | - |
3 | | -* [/composeApp](./composeApp/src) is for code that will be shared across your Compose Multiplatform applications. |
4 | | - It contains several subfolders: |
5 | | - - [commonMain](./composeApp/src/commonMain/kotlin) is for code that’s common for all targets. |
6 | | - - Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name. |
7 | | - For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app, |
8 | | - the [iosMain](./composeApp/src/iosMain/kotlin) folder would be the right place for such calls. |
9 | | - Similarly, if you want to edit the Desktop (JVM) specific part, the [jvmMain](./composeApp/src/jvmMain/kotlin) |
10 | | - folder is the appropriate location. |
11 | | - |
12 | | -* [/iosApp](./iosApp/iosApp) contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform, |
13 | | - you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project. |
14 | | - |
15 | | -### Build and Run Android Application |
16 | | - |
17 | | -To build and run the development version of the Android app, use the run configuration from the run widget |
18 | | -in your IDE’s toolbar or build it directly from the terminal: |
19 | | -- on macOS/Linux |
20 | | - ```shell |
21 | | - ./gradlew :composeApp:assembleDebug |
22 | | - ``` |
23 | | -- on Windows |
24 | | - ```shell |
25 | | - .\gradlew.bat :composeApp:assembleDebug |
26 | | - ``` |
27 | | - |
28 | | -### Build and Run Desktop (JVM) Application |
29 | | - |
30 | | -To build and run the development version of the desktop app, use the run configuration from the run widget |
31 | | -in your IDE’s toolbar or run it directly from the terminal: |
32 | | -- on macOS/Linux |
33 | | - ```shell |
34 | | - ./gradlew :composeApp:run |
35 | | - ``` |
36 | | -- on Windows |
37 | | - ```shell |
38 | | - .\gradlew.bat :composeApp:run |
39 | | - ``` |
40 | | - |
41 | | -### Build and Run Web Application |
42 | | - |
43 | | -To build and run the development version of the web app, use the run configuration from the run widget |
44 | | -in your IDE's toolbar or run it directly from the terminal: |
45 | | -- for the Wasm target (faster, modern browsers): |
46 | | - - on macOS/Linux |
47 | | - ```shell |
48 | | - ./gradlew :composeApp:wasmJsBrowserDevelopmentRun |
49 | | - ``` |
50 | | - - on Windows |
51 | | - ```shell |
52 | | - .\gradlew.bat :composeApp:wasmJsBrowserDevelopmentRun |
53 | | - ``` |
54 | | -- for the JS target (slower, supports older browsers): |
55 | | - - on macOS/Linux |
56 | | - ```shell |
57 | | - ./gradlew :composeApp:jsBrowserDevelopmentRun |
58 | | - ``` |
59 | | - - on Windows |
60 | | - ```shell |
61 | | - .\gradlew.bat :composeApp:jsBrowserDevelopmentRun |
62 | | - ``` |
63 | | - |
64 | | -### Build and Run iOS Application |
65 | | - |
66 | | -To build and run the development version of the iOS app, use the run configuration from the run widget |
67 | | -in your IDE’s toolbar or open the [/iosApp](./iosApp) directory in Xcode and run it from there. |
| 1 | +<div align="center"> |
68 | 2 |
|
69 | | ---- |
| 3 | + <img src="fastlane/metadata/android/en-US/images/6.png" width="100%" alt="Trease Cover" style="border-radius: 10px;"/> |
| 4 | + <h1>Trease</h1> |
| 5 | + |
| 6 | + <p> |
| 7 | + <strong>Cultivate focus. Reclaim your time.</strong> |
| 8 | + </p> |
| 9 | + |
| 10 | + <p> |
| 11 | + An open-source, cross-platform sanctuary for deep work. |
| 12 | + </p> |
| 13 | + |
| 14 | + <p> |
| 15 | + <a href="#download"><strong>Download</strong></a> · |
| 16 | + <a href="#features"><strong>Features</strong></a> · |
| 17 | + <a href="#contributing"><strong>Contributing</strong></a> |
| 18 | + </p> |
| 19 | + |
| 20 | + <br /> |
| 21 | + |
| 22 | + <img src="https://img.shields.io/badge/License-GNU-black?style=flat-square" alt="License" /> |
| 23 | + <img src="https://img.shields.io/badge/Built%20with-Kotlin%20Multiplatform-black?style=flat-square" alt="Tech Stack" /> |
| 24 | + <img src="https://img.shields.io/badge/Status-Active-black?style=flat-square" alt="Status" /> |
| 25 | + |
| 26 | +</div> |
| 27 | + |
| 28 | +<br /> |
| 29 | + |
| 30 | +## About |
| 31 | + |
| 32 | +**Trease** is an open-source focus tool. |
| 33 | + |
| 34 | +When you want to focus, plant a seed. As time passes, the seed grows into a tree. However, if you cannot resist the temptation of using your phone and leave the app, your tree will wither. |
| 35 | + |
| 36 | +> "The best time to plant a tree was 20 years ago. The second best time is now." |
| 37 | +
|
| 38 | +## Features |
70 | 39 |
|
71 | | -Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html), |
72 | | -[Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/#compose-multiplatform), |
73 | | -[Kotlin/Wasm](https://kotl.in/wasm/)… |
| 40 | +Trease is built with simplicity, privacy, and performance in mind using Kotlin Multiplatform. |
| 41 | + |
| 42 | +* **Unified Experience:** A single, native codebase providing fluid performance on Android, Linux, Windows, iOS. |
| 43 | +* **App Blocker:** Block distractions when focusing (only available on android rn ) |
| 44 | +* **Detailed Analytics:** Insightful charts to track your focus distribution over weeks and months. |
| 45 | +* **Visual Forest:** Watch your forest grow as you accumulate productive hours. |
| 46 | +* **Open Source:** No hidden tracking, no ads, and completely transparent code. |
| 47 | + |
| 48 | +## Visuals |
| 49 | + |
| 50 | +<div align="center"> |
| 51 | + <img src="fastlane/metadata/android/en-US/images/1.png" width="19%" alt="Screen 1" /> |
| 52 | + <img src="fastlane/metadata/android/en-US/images/2.png" width="19%" alt="Screen 2" /> |
| 53 | + <img src="fastlane/metadata/android/en-US/images/3.png" width="19%" alt="Screen 3" /> |
| 54 | + <img src="fastlane/metadata/android/en-US/images/4.png" width="19%" alt="Screen 4" /> |
| 55 | + <img src="fastlane/metadata/android/en-US/images/5.png" width="19%" alt="Screen 5" /> |
| 56 | +</div> |
| 57 | + |
| 58 | +## Download |
| 59 | + |
| 60 | +Trease can be downloaded by installing the specific executable for your device from github release. |
| 61 | +[Github Release](https://github.com/Trease-Focus/trease-app/releases) |
| 62 | +## Development |
| 63 | + |
| 64 | +Trease is built using **Kotlin Multiplatform (KMP)** and **Compose Multiplatform**. |
| 65 | + |
| 66 | +## Contributing |
| 67 | + |
| 68 | +We welcome contributions from the community. Whether it is a bug fix, a new feature, or design improvements, your help is appreciated. |
| 69 | + |
| 70 | + |
| 71 | +## License |
| 72 | + |
| 73 | +Trease is open-source software licensed under the [GNU License](LICENSE). |
| 74 | +All of trease artworks is licensed under the same license too. |
| 75 | +--- |
74 | 76 |
|
75 | | -We would appreciate your feedback on Compose/Web and Kotlin/Wasm in the public Slack channel [#compose-web](https://slack-chats.kotlinlang.org/c/compose-web). |
76 | | -If you face any issues, please report them on [YouTrack](https://youtrack.jetbrains.com/newIssue?project=CMP). |
| 77 | +Made by [Nethical](https://github.com/nethical6) |
0 commit comments