AndroidJetpack/Noto/README.md

<h1 align="center">
    <img src="images/Icon.svg" alt="icon" />
    <br />
    <b>Noto | Minimal Note-Taking App</b>
</h1>

<div align="center">
    <a href="https://developer.android.com/">
        <img src="images/badges/Android.svg" alt="Android" />
    </a>
    <a href="https://kotlinlang.org/">
        <img src="images/badges/Kotlin.svg" alt="Kotlin" />
    </a>
    <a href="https://crowdin.com/project/notoapp">
        <img src="images/badges/Crowdin.svg" alt="Crowdin" />
    </a>
    <a href="https://www.patreon.com/alialbaali">
        <img src="images/badges/Patreon.svg" alt="Patreon" />
    </a>
    <a href="https://www.buymeacoffee.com/alialbaali">
        <img src="images/badges/BMC.svg" alt="Buy Me A Coffee" />
    </a>
    <a href="https://t.me/notoapp">
        <img src="images/badges/Telegram.svg" alt="Telegram" />
    </a>
    <a href="/LICENSE.md">
        <img src="images/badges/Apache.svg" alt="License" />
    </a>
</div>

<br />

<p align="center">
    <a href="#download">Download</a>
    •
    <a href="#motivation">Motivation</a>
    •
    <a href="#features">Features</a>
    •
    <a href="#screenshots">Screenshots</a>
    •
    <a href="#translation--localization">Translation & Localization</a>
    •
    <a href="#contributions">Contributions</a>
    •
    <a href="#app-icons">App Icons</a>
    •
    <a href="#architecture">Architecture</a>
    •
    <a href="#community">Community</a>
    •
    <a href="#support">Support</a>
    •
    <a href="#license">License</a>
</p>

## Download

<div align="center">
    <h4><b>You can get Noto from one of the links below!</b></h4>
    <a href="https://play.google.com/store/apps/details?id=com.noto">
        <img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" alt="Get it on Google Play" height="60" />
    </a>
    <a href="https://f-droid.org/en/packages/com.noto">
        <img src="images/get-it-on-fdroid-en-us.svg" alt="Get it on F-Droid" height="60" />
    </a>
    <a href="https://apt.izzysoft.de/fdroid/index/apk/com.noto">
        <img src="images/get-it-on-izzy-on-droid.png" alt="Get it on IzzyOnDroid" height="60" />
    </a>
    <a href="https://github.com/alialbaali/Noto/releases/latest">
        <img src="images/get-it-on-github.png" alt="Get it from GitHub" height="60" />
    </a>
</div>

## Motivation

<p>
There are a lot of note-taking apps available out-there, but only a few that do it well. Well, Noto is one of them.

The goal of Noto is to be a minimalistic, free, and open-source note-taking application that meets the user's
expectations, with privacy in mind.

Noto is also part of my [portfolio](https://alialbaali.com) projects. It showcases my skills regarding software development.
</p>

## Features

### General

* Ad-Free.
* Private and secure.
* Small APK size (around 5 MB).
* Minimal, modern, and simplistic design.
* Light/Dark/Black/System themes.
* Support for devices with API 21 (Lollipop) and up.
* All data is stored locally on the device.
* Language support for English, Turkish, Arabic, Indonesian, Russian, Czech, German, Italian, Spanish, and French, Lithuanian, SimplifiedChinese, and
  Portuguese.
* Material You (Material 3) support.
* Navigating to the top when clicking on the top app bar.

### Folders

* Colorful folders.
* Folders archive.
* Folders vault.
* Pinned folders.
* Sorting folders alphabetically, by creation date, or manually.
* Folders widget.

### Notes

* Multi sequential selection for notes.
* Option to merge selected notes.
* Notes archive.
* List and grid layouts.
* Auto save.
* Undo/Redo with history view.
* Undo/Redo swiping gestures.
* Reminders.
* Copy/Move/Duplicate note options.
* Word-count.
* Pinned notes.
* Sorting alphabetically, by access date, by creation date, or manually.
* Grouping notes by label, by access date, or by creation date.
* Notes widget.
* All notes view with search functionality.
* Recently accessed notes view with search functionality.
* Saving selected text by using Quick note option. Default folder is General, can be overridden in Settings.
* Find in Note, and automatic scrolling to the searched text in notes.

### Labels

* Filtering notes using labels unique to each folder.
* Inclusive/Exclusive/Strict label filtering.

### Reading Mode

* Full-Screen mode option.
* Do Not Disturb mode option.
* Keep screen on option.
* Quick edit (Jumping to the scrolled text).
* Custom screen brightness level option.
* Paging notes support, like reading a book.
* Support for paging only selected/filtered notes.
* Option to open notes in Reading Mode by default.

### Settings

* Export/Import all app data.
* Custom app icons.
* Remembering folders and notes scrolling position.

## Screenshots

<details>
  <summary>Click to expand screenshots</summary>

  <div>
    <p float="left">
      <img src="images/Frame1.png" height="400"  alt="screenshot"/>
      <img src="images/Frame2.png" height="400"  alt="screenshot"/>
      <img src="images/Frame3.png" height="400"  alt="screenshot"/>
      <img src="images/Frame4.png" height="400"  alt="screenshot"/>
    </p>
    <p>
      <img src="images/Frame5.png" height="400"  alt="screenshot"/>
      <img src="images/Frame6.png" height="400"  alt="screenshot"/>
      <img src="images/Frame7.png" height="400"  alt="screenshot"/>
      <img src="images/Frame8.png" height="400"  alt="screenshot"/>
    </p>
  </div>
</details>

## Translation & Localization

<p>
  If you would like to translate the app, please contact me via <a href="mailto:noto@alialbaali.com">email</a>.
  Translations are done through <a href="https://crowdin.com/project/notoapp">Crowdin</a>.
</p>

#### Special thanks to:

- <a href="https://linkedin.com/in/nuraysabri/">Nuray Sabri</a>,
  and <a href="https://sakci.me">Alparslan Şakçi</a> for
  the Turkish localization.
- <a href="https://github.com/faus32">Faus AM</a> for the Spanish localization.
- <a href="https://github.com/kernoeb">Kernoeb</a>,
  and <a href="https://geoffreycrofte.com">Geoffrey Crofte</a> for the
  French localization.
- <a href="https://github.com/matteolomba">Matteo Lombardi</a>,
  and <a href="https://github.com/SimoneG97">SimoneG</a>
  for the Italian localization.
- <a href="https://github.com/vikdevelop">Viktor Novák</a> for the Czech localization.
- <a href="http://github.com/ErnestasKaralius">Ernestas Karalius</a> for the Lithuanian localization.
- <a href="https://steamcommunity.com/id/oliverberry">李華</a> for the Simplified Chinese localization.
- Uli N for the German localization.
- <a href="https://angellabs.xyz">Angel C</a>.
- Alexthegib for the Portuguese localization.
- <a href="https://github.com/x-0D">&lt;x0D&gt; Nikita Bragin</a> for the Russian localization.

## Contributions

<p>
  Contributions are always welcome, and highly appreciated! If you would like to contribute, feel free to file an issue, create a PR, or star the project.
</p>

#### Special thanks to everyone who has helped and contributed in the development.

## App Icons

App icons use <a href="https://www.figma.com/community/file/830405806109119447/">Collection of Gradients</a> published
by <a href="https://geoffreycrofte.com/">Geoffrey Crofte</a> licensed
under <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>.

## Architecture

#### The app is built with the Kotlin language.

The app uses Clean Architecture with MVVM design pattern, and it's divided into 3 main layers.

#### Domain

Contains model, repository and data sources interfaces.

#### Data

Contains database and repository and DAO implementations.

#### Presentation (the rest of the app)

Contains all the UI logic.

## Community

Feel free to join the community to stay up to date with the latest news.

<div align="center">
  <a href="https://t.me/notoapp">
    <img src="images/Telegram.svg" alt="Telegram"/>
  </a>
</div>

## Support

I'm a **solo** developer, and **Noto** was one of my first projects when I started learning Software Development
almost **4 years ago**, and it has come a long way since then. I also have worked on various side projects, but **Noto**
remained to this day **my main focus**.

So, if you'd like to see **Noto** remains maintained with new features, improvements, and bug fixes, I would
really **appreciate** any support coming from my **amazing** community 🤗

<br/>

<div align="center">
  <a href="https://www.buymeacoffee.com/alialbaali">
      <img src="images/BMC.png" alt="Buy Me A Coffee" height="50">
  </a>
  <a href="https://www.patreon.com/alialbaali">
    <img src="images/Patreon.png" alt="Become a Patron" height="50"/>
  </a>
</div>

<br/>

**Thank you ❤️**

## License

Noto is distributed under the terms of the Apache License (Version 2.0). See [License](LICENSE.md) for details.