An open API service indexing awesome lists of open source software.

https://github.com/softartdev/notedelight

Multiplatform note app with encryption
https://github.com/softartdev/notedelight

cipher compose coroutines dark-theme encryption espresso fastlane jetpack-compose koin kotlin kotlin-coroutines kotlin-multiplatform kotlin-multiplatform-mobile notes sqldelight sqlite tdd ui-tests unit-tests

Last synced: about 15 hours ago
JSON representation

Multiplatform note app with encryption

Awesome Lists containing this project

README

          

# Note Delight πŸ“πŸ”

[![Kotlin Multiplatform CI](https://github.com/softartdev/NoteDelight/actions/workflows/kmp.yml/badge.svg)](https://github.com/softartdev/NoteDelight/actions/workflows/kmp.yml)
[![Android CD](https://github.com/softartdev/NoteDelight/actions/workflows/android.yml/badge.svg)](https://github.com/softartdev/NoteDelight/actions/workflows/android.yml)
[![iOS CD](https://github.com/softartdev/NoteDelight/actions/workflows/ios.yml/badge.svg)](https://github.com/softartdev/NoteDelight/actions/workflows/ios.yml)
[![Desktop Java CD](https://github.com/softartdev/NoteDelight/actions/workflows/desktop.yaml/badge.svg)](https://github.com/softartdev/NoteDelight/actions/workflows/desktop.yaml)
[![Web CD](https://github.com/softartdev/NoteDelight/actions/workflows/web.yml/badge.svg)](https://github.com/softartdev/NoteDelight/actions/workflows/web.yml)

[Kotlin Multiplatform](https://kotlinlang.org/lp/mobile/) application for create notes in SQLite
database with [SQLDelight](https://github.com/cashapp/sqldelight) library, and encrypt it
with [Cipher](https://www.zetetic.net/sqlcipher/). The Compose-UI also has dark/light themes and
adaptive phone/tablet layouts. Localizations: en/ru.

Supported platforms:

- Android
- iOS (+ macOS [(Mac Catalyst)](https://developer.apple.com/mac-catalyst/))
- Desktop JVM (macOS, Linux, Windows)x(x86_64, arm64)
- Web (experimental - in development preview)

[![google_play_badge](docs/badges/badge-google-play.svg)](https://play.google.com/store/apps/details?id=com.softartdev.noteroom)
[![app_store_badge](docs/badges/badge-app-store.svg)](https://apps.apple.com/ge/app/note-delight/id6444444290)
[![github_badge](docs/badges/badge-github.svg)](https://github.com/softartdev/NoteDelight/releases)
[![web_badge](docs/badges/badge-web.svg)](https://softartdev.github.io/NoteDelight/)

## SCREENSHOTS 🎞️


[More screenshoots…](/docs/screenshoots/screenshots.md)

## ARCHITECTURE πŸ›

![Architecture blueprint for this project](docs/diagrams/architecture.png)

## WORK IN PROGRESS πŸ› 

| feature \ platform | Android | iOS | Desktop Java | Web |
|:------------------:|:-------:|:---:|:------------:|:---:|
| database | βœ… | βœ… | βœ… | βœ… |
| encryption | βœ… | βœ… | βœ… | |
| ui | βœ… | βœ… | βœ… | βœ… |

Check out [CONTRIBUTING.md](/CONTRIBUTING.md) if you want to develop missing features.

## CONTINUOUS INTEGRATION / DELIVERY ♻️

![CI/CD workflows blueprint for this project](docs/diagrams/ci_cd.png)

## DOCUMENTATION πŸ“–

- **[docs/README.md](docs/README.md)** - Documentation index and quick reference
- **[docs/MANUAL_BUILD_INSTALL.md](docs/MANUAL_BUILD_INSTALL.md)** - Manual build and install guide for all platforms
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Contribution guidelines, code style, development workflow
- **Module READMEs** - Each module folder has detailed documentation

## LIBRARY DEPENDENCIES πŸ“š

- [SQLDelight](https://github.com/cashapp/sqldelight)
- [SQLCipher](https://github.com/sqlcipher/sqlcipher)
- [Compose Multiplatform, by JetBrains](https://github.com/JetBrains/compose-jb)
- [MaterialThemePrefs](https://github.com/softartdev/MaterialThemePrefs)
- [kotlinx-coroutines](https://github.com/Kotlin/kotlinx.coroutines)
- [kotlinx-datetime](https://github.com/Kotlin/kotlinx-datetime)
- [Koin](https://github.com/InsertKoinIO/koin)
- [CWAC-SafeRoom](https://github.com/commonsguy/cwac-saferoom) - my [fork](https://github.com/softartdev/cwac-saferoom)
- [Kermit](https://github.com/touchlab/Kermit)
- [Firebase Crashlytics](https://firebase.google.com/products/crashlytics)
- [LeakCanary 🐀](https://github.com/square/leakcanary)
- [Mockito](https://github.com/mockito/mockito)
- [Turbine](https://github.com/cashapp/turbine)
- [Orchestrator](https://developer.android.com/training/testing/instrumented-tests/androidx-test-libraries/runner#use-android)
- [Espresso](https://developer.android.com/training/testing/espresso)