README.md

June 7, 2026 ยท View on GitHub

Logo

Simple Notes Sync

Clean, offline-first notes with intelligent sync - simplicity meets smart synchronization.

Android Kotlin Jetpack Compose Material 3 License Donate

Get it on IzzyOnDroid Get it on Obtainium Get it on F-Droid Get it on Google Play
SHA-256 hash of the signing certificate:
42:A1:C6:13:BB:C6:73:04:5A:F3:DC:81:91:BF:9C:B6:45:6E:E4:4C:7D:CE:40:C7:CF:B5:66:FA:CB:69:F1:6A


๐Ÿ“ฑ APK Download ยท ๐Ÿ“– Documentation ยท ๐Ÿš€ Quick Start
๐ŸŒ Deutsch ยท English

๐Ÿ“ฑ Screenshots

Notes overview Note editor Checklist Self-hosted server settings Google Keep import Themes and AMOLED

๐Ÿ“ Offline-first ย โ€ขย  ๐Ÿ”„ Smart Sync ย โ€ขย  ๐Ÿ”’ Self-hosted ย โ€ขย  ๐Ÿ”‹ Battery-friendly

โœจ Highlights

  • ๐Ÿ“ Offline-first - Works without internet
  • ๐Ÿ“Š Flexible views - Switch between list and grid layout, 1โ€“5 column scaling
  • โœ… Checklists - Tap-to-check, drag & drop
  • ๐Ÿ”„ Configurable sync triggers - onSave, onResume, WiFi-connect, periodic (15/30/60 min), boot
  • ๐Ÿ“Œ Widgets - Home screen quick-note and note list widgets
  • ๐Ÿ”€ Smart sorting - By title, date modified, date created, type
  • โšก Parallel sync - Downloads up to 5 notes simultaneously
  • ๐ŸŒ Multilingual - English/German with language selector
  • ๐Ÿ”’ Self-hosted - Your data stays with you (WebDAV)
  • ๐Ÿ’พ Local backup - Export/Import as JSON file (encryption available)
  • ๐Ÿ–ฅ๏ธ Desktop integration - Markdown export for Obsidian, VS Code, Typora
  • ๐Ÿ“ค Share & export - Share as text or PDF, export to calendar
  • โ†ฉ๏ธ Undo/Redo - Full undo/redo history in the note editor
  • ๐ŸŽจ Material Design 3 - 7 color schemes incl. AMOLED & Dynamic Color, animated theme transitions

โžก๏ธ Complete feature list: FEATURES.md

๐Ÿš€ Quick Start

1. Server Setup (5 minutes)

git clone https://github.com/inventory69/simple-notes-sync.git
cd simple-notes-sync/server
cp .env.example .env
# Set password in .env
docker compose up -d

โžก๏ธ Details: Server Setup Guide

2. App Installation (2 minutes)

  1. Download APK
  2. Install & open
  3. โš™๏ธ Settings โ†’ Configure server:
    • URL: http://YOUR-SERVER-IP:8080/ (base URL only!)
    • User: noteuser
    • Password: (from .env)
    • WiFi: (your network name)
  4. Test connection โ†’ Enable auto-sync
  5. Done! ๐ŸŽ‰

โžก๏ธ Detailed guide: QUICKSTART.md

๐Ÿ“š Documentation

DocumentContent
QUICKSTART.mdStep-by-step installation
FEATURES.mdComplete feature list
BACKUP.mdBackup & restore guide
DESKTOP.mdDesktop integration (Markdown)
SELF_SIGNED_SSL.mdSelf-signed SSL certificate setup
DOCS.mdTechnical details & troubleshooting
CHANGELOG.mdVersion history
UPCOMING.mdUpcoming features ๐Ÿš€
TRANSLATING.mdTranslation guide ๐ŸŒ
cd android
./gradlew assembleStandardRelease

โžก๏ธ Build guide: DOCS.md

๐Ÿ’ก Feature Requests & Ideas

Have an idea for a new feature or improvement? We'd love to hear it!

โžก๏ธ How to suggest features:

  1. Check existing discussions to see if someone already suggested it
  2. If not, start a new discussion in the "Feature Requests / Ideas" category
  3. Upvote (๐Ÿ‘) features you'd like to see

Features with enough community support will be considered for implementation. Please keep in mind that this app is designed to stay simple and user-friendly.

๐ŸŒ Translations

Translation hosting generously provided by Weblate - thank you for sponsoring open-source projects! ๐Ÿ™

Translation status

Translation status

๐Ÿค Contributing

Contributions welcome! See CONTRIBUTING.md

If you find this app useful, you can support its development:

Donate via Liberapay

๐Ÿ“„ License

GNU Affero General Public License v3.0 - see LICENSE



v2.7.2 ยท Built with โค๏ธ using Kotlin + Jetpack Compose + Material Design 3