karui - GitLite

KO | EN

gitlite — search

#ai #android #machine-learning #linux #docker #macos #java #cli #vue #awesome-list #security #ios #openai #open-source

karui

(★ 121)

A privacy friendly, aesthetically pleasing google tasks alternative to do list app, inspired by system-24 theme and windows mobile design system. It's just a 85kb apk.

파일 탐색기

최종 버전 다운로드 (.zip)

- - android.yml
  - diagram.yml
  - fix-wrapper.yml
  - release.yml
  - static.yml
- build.gradle
- proguard-rules.pro
- - alpine.cdn.min.js
  - index.html
  - main.js
  - milligram.css
  - normalize.css
- - App.svelte
  - index.html
  - main.js
- - about.js
  - index.html
  - new.html
  - notescreen.js
  - old.html
  - usage.js
- - gradle-wrapper.jar
  - gradle-wrapper.properties
.gitattributes
.gitignore
build.gradle
diagram.svg
gradle.properties
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Karui ToDo

<div align="center">
  <img src="fastlane/metadata/android/en-US/images/icon.png" alt="App Icon" width="45%">
</div>

![alpinejs](https://img.shields.io/badge/Alpine%20JS-8BC0D0?style=for-the-badge&logo=alpinedotjs&logoColor=black)
![svelte](https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
)
![vite](https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge&logo=vite&logoColor=FFD62E)
![pnpm](https://img.shields.io/badge/pnpm-yellow?style=for-the-badge&logo=pnpm&logoColor=white)
![node](https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)
![notepad++](https://img.shields.io/badge/Notepad++-90E59A.svg?style=for-the-badge&logo=notepad%2B%2B&logoColor=black)
![alpine](https://img.shields.io/badge/Alpine_Linux-0D597F?style=for-the-badge&logo=alpine-linux&logoColor=white)
![android](https://img.shields.io/badge/Android-3DDC84?style=for-the-badge&logo=android&logoColor=white)
![tauri](https://img.shields.io/badge/Tauri-FFC131?style=for-the-badge&logo=Tauri&logoColor=white)
![androidstudio](https://img.shields.io/badge/Android_Studio-3DDC84?style=for-the-badge&logo=android-studio&logoColor=white)
![gpl3](https://img.shields.io/badge/GPL--3.0-red?style=for-the-badge)
[![RB Status](https://shields.rbtlog.dev/simple/io.github.ronynn.karui?style=for-the-badge)](https://shields.rbtlog.dev/io.github.ronynn.karui)

<!--
![academia](https://img.shields.io/badge/Academia-41454A?style=for-the-badge&logo=academia&logoColor=white)

![mint](https://img.shields.io/badge/Linux_Mint-87CF3E?style=for-the-badge&logo=linux-mint&logoColor=white)

![arch](https://img.shields.io/badge/Arch_Linux-1793D1?style=for-the-badge&logo=arch-linux&logoColor=white)

-->

- An open source Google Tasks alternative to quickly jot down things to do, inspired by the system-24 theme and the Windows Mobile design system.
- This app's design is set to evolve into something even more eye-catching.

## Screenshots

<div align="center">
  <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" alt="Screenshot 1" width="45%">
  <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" alt="Screenshot 2" width="45%">
  <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" alt="Screenshot 3" width="45%">
  <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.png" alt="Screenshot 4" width="45%">
  <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" alt="Screenshot 5" width="45%">
  <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" alt="Screenshot 6" width="45%">
  <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/7.png" alt="Screenshot 7" width="45%">
  <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/8.png" alt="Screenshot 8" width="45%">
</div>

## Features

- **Simple note taking and list making:** Includes an undo delete feature.
- **Retro terminalesque design:** Inspired by Unix customizations found online.
- Use unix like commands to set or remove notes tabs.
- **Lightweight:** Consumes only 0.05% CPU and 128KB of RAM. After all, simple apps shouldn't need more—remember, the Apollo mission operated on a computer with around 4KB of RAM!
- **Highly customizable:** Offers many themes with plans to add more customizations such as fonts, font sizes, and border colors.

## Recently Added New Features

So many new features might as well call it Karui++ now. Almost all new features are toggleable and don't add any bloat per say

- Add notes from status bar, or from other apps when selecting text (my mind races with ideas when watching youtube so I added this feature), helpful for saving trivial stuff you notice when reading some article or maybe for searching it later.
- Bolder New UI Design, leaning slightly more into windows8 metro aspects
- UI size options
- Floating button on bottom right of the app to bring input box in focus
- Sort Alphabetically
- Add a % symbol on any tabname and it automatically counts percentage of tasks completed
- Optionally disable screenshots for privacy when screensharing or in general
- Optional UI Sounds
- Optional celebration mode with confetti
- Easter egg games (what? my todolist has games?), following the trend from back in the days
- Optional button ripple effects

~~Features That Won't Be Added:  **Editing a note:** Experience shows that editing a todo list can lead to chaining multiple tasks. The purpose here is to quickly jot down ideas and tasks, not for deep thinking. For that, a dedicated text editor is more appropriate. (Open to discussion!)~~
- Now you can edit notes, √c and √d options replaced by a : dropdown

Bug Fixes/Additional options
- Keep keyboard on when switching tabs
- Longpressing tab now always puts the dropdown in the center

## Working Demos before downloading

- ![Youtube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white) : Click and Watch this short [Youtube Demo](https://www.youtube.com/shorts/QCDx0tuOL2g)
 on using karui and about it's development.

## No Cloud Integration

- This app is designed to operate entirely locally, with no cloud storage involved. The app doesn't asks for internet permissions and cannot connect to the internet. Further updates won't add internet permissions either, by design.

## Usage

- Use the input box to make new notes, touch a note to strikethough it, marking it done.
- Pressing √d deletes a note  it can be restored from recycle bin with √r, √e empties the recycle bin.
- To add a new note tab, use the `///TabName` format.
- To remove any tab (except the Main tab), use the `\\\TabName` format.
- Long press any tab to rename or delete it, or add new tab.
- Custom fonts are now supported.
- Add a % symbol on any tabname and it automatically counts percentage of tasks completed
- Easter Eggs: Read the source code to find codes that unlock easter egg games in the app.

## Latest Releases for Download

|Github | <center>[![Get it on GitHub](https://img.shields.io/badge/Get_it_on-GitHub-181717?logo=github&logoColor=white&style=for-the-badge)](https://github.com/ronynn/karui/releases) </center>|
|---|---|
|IzzyOnDroid | <center>[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroidButtonGreyBorder_nofont.png" height="53" alt="Get it at IzzyOnDroid">](https://apt.izzysoft.de/packages/io.github.ronynn.karui)</center> |
|F-droid | [<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/packages/io.github.ronynn.karui)  |

- ![Downloads (all time)](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgithub.com%2Fkitswas%2Ffdroid-metrics-dashboard%2Fraw%2Frefs%2Fheads%2Fmain%2Fprocessed%2Ftotal%2Fio.github.ronynn.karui.json&query=%24.total_downloads&logo=fdroid&label=Downloads%20(all%20time))
[![IzzyOnDroid Yearly Downloads](https://img.shields.io/badge/dynamic/json?url=https://dlstats.izzyondroid.org/iod-stats-collector/stats/basic/yearly/rolling.json&query=$.['io.github.ronynn.karui']&label=IzzyOnDroid%20yearly%20downloads)](https://apt.izzysoft.de/packages/io.github.ronynn.karui)
- ![F-Droid Version](https://img.shields.io/f-droid/v/io.github.ronynn.karui)
![izzy](https://img.shields.io/endpoint?url=https://apt.izzysoft.de/fdroid/api/v1/shield/io.github.ronynn.karui&label=IzzyOnDroid&style=flat)

![rss](https://img.shields.io/badge/RSS-FFA500?style=for-the-badge&logo=rss&logoColor=white) : Stay updated via our [RSS feed for GitHub releases](https://github.com/ronynn/karui/releases.atom) which includes detailed release notes.

## Licenses
Karui is being developed under the GPLv3 License.

## Contributions
Contributions are welcome, setting up takes nothing more than forking the project and utilising the github actions build setup
~~Currently I am porting the project from alpinejs to svelte, so I expect new contributions in svelte, but it's not a steadfast rule, I am still learning svelte and porting alpinejs based code so far hasn't feel like any hassle so far.~~ The frontend is completely terse vanillajs at the moment.

- ![dev.to](https://img.shields.io/badge/dev.to-0A0A0A?style=for-the-badge&logo=devdotto&logoColor=white
) : Dev.to post on [Automating Android APK Builds with GitHub Actions (The Sane Way)](https://dev.to/ronynn/automating-android-apk-builds-with-github-actions-the-sane-way-1h95)

## Roadmap

- [x] Get user feedback and suggestions to improve and expand the project scope
- [x] Fix import `.json` bugs
- [x] Enhance accessibility with larger touch areas
- [x] Pivot control styled tab switcher
- [x] Gesture flick to change tabs
- [x] Karui opening theme should be gruvbox?
- [ ] Resolve dynamic color issues (😔 still figuring this one out—maybe a short break is needed)(i need a pc that can run android studio well, github workflows setup feels difficult to get this done)
- [x] Font size settings
- [x] Introduce more themes and font options.
- [x] Make the UI more responsive for tablets and larger screens
- [x] Letting user to select their own fonts from file picker
- [x] Pressing active tab tries to do some animation (#bug)
- [x] Toggle option to use double tap √d to delete instead of a single tap
- [x] Tab adding bar position fix

Cancelled items from roadmap
- [ ] Add translations (didn't face the need)
- [ ] Develop widgets (e.g., Java fetching notes from localStorage, a static scrollable list of existing notes)(very difficult)
- [ ] Explore cloud saving options without internet connection (piping to arcane chat? how would it sync?)(syncing will be too messy, just export json when changing phones)
- [ ] Integrate app data piping to Obsidian or a new notes app (I dont use obsidian on android any more, too slow)
- [ ] Add share intent functionality (to support QR apps that generate QR codes from text or `.json`) (qr is limited to 3kb at best, compressing todos to fit that feels odd and limited feature)
- [ ] Incorporate a QR library to generate QR codes from notes and read them using the system camera, facilitating easy note sharing between devices. (qr too limited)

## Follow the Development

This app has been primarily made on my phone with Acode editor with alpine linux terminal (now on termux), while the dev environment doesn't matter, if you are building something with retro aesthetics or just with a minimalist design approach, show us your projects.

- [![telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white
)](https://t.me/karuifoss) : Join us on telegram: <https://t.me/karuifoss>  Here you can find my thought process and approach with other's opinions.
- [![discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white
)](https://discord.gg/sYFsGN69rZ) : We now have recently created a discord server, here's the invite link:  <https://discord.gg/sYFsGN69rZ>, you can join and chat (on foss development) [![](https://dcbadge.limes.pink/api/server/sYFsGN69rZ)](https://discord.gg/sYFsGN69rZ)
  
- [![reddit](https://img.shields.io/badge/Reddit-FF4500?style=for-the-badge&logo=reddit&logoColor=white)](https://reddit.com/r/karuifoss) : And also a subreddit: <https://reddit.com/r/karuifoss>, would love it if you showcase your projects here and get cool discussions rolling

---

- [![Bluesky](https://img.shields.io/badge/Bluesky-0285FF?logo=bluesky&logoColor=fff&style=for-the-badge)](https://bsky.app/profile/amayorilabs.bsky.social) : Occasional thoughts on <https://bsky.app/profile/amayorilabs.bsky.social>, on rare occasions experts find my posts and share their insights.

- [![Youtube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://m.youtube.com/@ronynn89) : ronynn's findings <https://m.youtube.com/@ronynn89> on all things tech, art, and filmmaking

- [![dev.to](https://img.shields.io/badge/dev.to-0A0A0A?style=for-the-badge&logo=devdotto&logoColor=white
)](https://dev.to/ronynn) : My blog <https://dev.to/ronynn> for tech opinions and findings

- [![Homepage](https://img.shields.io/badge/GitHub%20Pages-222222?style=for-the-badge&logo=github%20Pages&logoColor=white)](https://ronynn.github.io) : My [homepage](https://ronynn.github.io) has a threejs interactive wireframe of a globe, uses github api to fetch and link some of my repos.
- [![github](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/ronynn/karui/issues) : Github Issues are still the fastest way to get in touch.

![Visualization of this repo](https://raw.githubusercontent.com/ronynn/karui/master/diagram.svg)

If you like the app, don't forget to leave a star ⭐ here on github and let me know your suggestions!