Skip to content

Repository files navigation

OfflineNotes

OfflineNotes Banner

License: AGPL v3 Stars Forks Issues Last Commit

OfflineNotes is an Android notes app built to be simple, private, and offline-first. Source of truth is plain text files (.org and .md) in a user-selected folder.

Status: Alpha release (em evolucao / work in progress).

PT-BR: Eu criei este projeto sinceramente para suprir uma necessidade pessoal minha: ter um app de notas simples, privado e offline de verdade. Estou compartilhando no GitHub para outras pessoas que tambem queiram um app de notas offline com 0 conexoes do app no fluxo de anotacoes.

EN: I honestly built this project to solve a personal need of mine: a simple, private, truly offline notes app. I am sharing it on GitHub for others who also want an offline notes app with 0 in-app network connections during the note workflow.

Instalacao rapida / Quick install

  • GitHub Releases: https://github.com/leonamduarte/offline-notes/releases
  • Baixe / Download: OfflineNotes-v<versionName>+<versionCode>-release.apk
  • Android: permita instalacao de fontes desconhecidas / allow unknown sources when prompted
  • Auto-update opcional / Optional auto-update: Obtainium (rastreando este repo / tracking this repo)

PT-BR

Visao geral

  • 100% offline para o uso principal (anotacoes).
  • Sem backend, sem conta, sem telemetria e sem analytics.
  • Usa SAF (ACTION_OPEN_DOCUMENT_TREE) para leitura/escrita de arquivos.
  • Arquivos .org e .md sao a fonte de verdade.

Recursos

  • Lista e edicao de notas locais.
  • Criacao rapida de nota (.org padrao; alternavel para markdown).
  • Checklist por texto (- [ ], - [x], - [X]).
  • Renomear, excluir, auto-save.
  • Modo Edit e View no editor.
  • Preview basico para Org/Markdown (headers, listas, checklists, negrito/italico, inline code, links).

Como rodar

./gradlew :app:assembleDebug
adb install -r app/build/outputs/apk/debug/app-debug.apk

Instalacao

  • Download do APK pela pagina de releases do GitHub: https://github.com/leonamduarte/offline-notes/releases
  • Baixe o arquivo mais recente OfflineNotes-v<versionName>+<versionCode>-release.apk.
  • Instale no Android e permita instalacao de fontes desconhecidas quando solicitado.

Atualizacoes via Obtainium (opcional)

  • Instale o app Obtainium no seu Android.
  • Adicione este repositorio: https://github.com/leonamduarte/offline-notes.
  • Configure para acompanhar Releases estaveis (sem pre-release).
  • O Obtainium baixa e avisa sobre novas versoes publicadas.
  • O OfflineNotes continua sem conexao externa para o fluxo de notas.

Distribuicao via GitHub Releases (APK release)

./gradlew :app:assembleRelease
ls app/build/outputs/apk/release/

git tag -a v0.1.0 -m "OfflineNotes v0.1.0"
git push origin v0.1.0

gh release create v0.1.0 \
  app/build/outputs/apk/release/OfflineNotes-v0.1.0+1-release.apk \
  --title "OfflineNotes v0.1.0" \
  --notes "## Highlights
- ...
"

As credenciais de assinatura release sao lidas por variaveis de ambiente. Veja RELEASING.md.

Comandos de validacao

./gradlew :app:testDebugUnitTest
./gradlew :app:lint
./gradlew :app:assembleDebug

Privacidade (resumo)

  • O app nao precisa de internet para funcionar.
  • O app nao envia seus dados para servidores.
  • O app nao coleta dados pessoais, nao rastreia uso e nao usa SDK de analytics.
  • Atualizacoes automaticas, quando usadas, sao feitas por app externo (Obtainium), nao pelo OfflineNotes.
  • Todo conteudo fica sob controle do usuario, na pasta selecionada via SAF.
  • Seus dados sao seus, apenas seus.

Politica completa: veja PRIVACY.md.

EN

Overview

  • Fully offline for the core use case (note taking).
  • No backend, no account, no telemetry, no analytics.
  • Uses SAF (ACTION_OPEN_DOCUMENT_TREE) for file read/write access.
  • .org and .md files are the source of truth.

Features

  • Local note listing and editing.
  • Quick note creation (.org by default, switchable to markdown).
  • Text checklist support (- [ ], - [x], - [X]).
  • Rename, delete, auto-save.
  • Edit and View editor modes.
  • Basic Org/Markdown preview (headings, lists, checklists, bold/italic, inline code, links).

Run locally

./gradlew :app:assembleDebug
adb install -r app/build/outputs/apk/debug/app-debug.apk

Installation

Updates via Obtainium (optional)

  • Install the Obtainium app on your Android device.
  • Add this repository: https://github.com/leonamduarte/offline-notes.
  • Track stable releases (pre-release disabled).
  • Obtainium will detect and notify/download new published versions.
  • OfflineNotes itself remains offline for the notes workflow.

GitHub Releases distribution (release APK)

./gradlew :app:assembleRelease
ls app/build/outputs/apk/release/

git tag -a v0.1.0 -m "OfflineNotes v0.1.0"
git push origin v0.1.0

gh release create v0.1.0 \
  app/build/outputs/apk/release/OfflineNotes-v0.1.0+1-release.apk \
  --title "OfflineNotes v0.1.0" \
  --notes "## Highlights
- ...
"

Release signing credentials are loaded from environment variables. See RELEASING.md.

Validation commands

./gradlew :app:testDebugUnitTest
./gradlew :app:lint
./gradlew :app:assembleDebug

Privacy (summary)

  • The app does not require internet access to work.
  • The app does not upload your notes to remote servers.
  • The app does not collect personal data, track usage, or include analytics SDKs.
  • Automatic updates, when used, are handled by an external app (Obtainium), not by OfflineNotes.
  • All data stays under user control in the SAF-selected folder.
  • Your data is yours, and only yours.

Full policy: see PRIVACY.md.

License

This project is licensed under GNU AGPLv3.

If you distribute a modified version, you must provide the corresponding source code under AGPLv3. AGPL obligations can also apply when modified versions are provided for network use.

See LICENSE.

Third-party credits

OfflineNotes uses Android and Jetpack libraries (AndroidX / Google ecosystem), such as Compose, Navigation, DataStore, DocumentFile, Material Components, and JUnit for tests.

These dependencies are from third-party open-source projects and should be acknowledged. See THIRD_PARTY_NOTICES.md for a concise notice list.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages