README.md
July 26, 2026 ยท View on GitHub
Simple Notes Sync
Clean, offline-first notes with intelligent sync - simplicity meets smart synchronization.
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
๐ Offline-first ย โขย ๐ Smart Sync ย โขย ๐ Self-hosted ย โขย ๐ Battery-friendly
โจ Highlights
- ๐ Offline-first - Works without internet
- ๐ Folders - Organize notes into folders, with optional local-only folders that never sync
- ๐ Pinned notes - Keep important notes at the top
- ๐๏ธ Trash - Deleted notes move to a recycle bin with configurable retention (0โ90 days)
- ๐๏ธ Archive - Move notes out of the way without deleting them, restore anytime
- โ Checklists - Tap-to-check, drag & drop, convert text โ checklist
- โ๏ธ Live Markdown - Live highlighting in the editor and rendered list/grid previews
- ๐ Rich clipboard paste - HTML paste from Telegram, Word, Google Docs & browsers converts to Markdown
- ๐จ Note colors - Color-code notes, then filter and sort by color
- ๐ฅ Google Keep import - Bring your notes over from a Keep export
- ๐ Flexible views - List or grid layout, 1โ5 column scaling, adjustable font size, collapsible & reorderable sections
- ๐งฉ Widgets - Single-note, scrollable note-list, and quick-new-note home screen widgets
- ๐ Configurable sync triggers - onSave, onResume, WiFi-connect, periodic (15/30/60 min), boot
- โก Parallel sync - Uploads/downloads up to 5 notes simultaneously
- ๐ Self-hosted - Your data stays with you (WebDAV, encrypted credentials)
- ๐ App lock - Optional biometric/PIN unlock with screenshot protection
- ๐พ Local backup - Export/Import as JSON file
- ๐ฅ๏ธ Desktop integration - Markdown export for Obsidian, VS Code, Typora
- ๐ป Desktop editor (beta) - Edit your notes on Windows & Linux with Simple Notes Desktop, the WebDAV-synced companion app
- ๐ค Share & export - Receive shared text, share as text or PDF, export to calendar
- โฉ๏ธ Undo/Redo - Full undo/redo history in the note editor
- ๐ Multilingual - 11 languages with in-app language selector
- ๐จ 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)
- Download APK
- Install & open
- โ๏ธ Settings โ Configure server:
- URL:
http://YOUR-SERVER-IP:8080/(base URL only!) - User:
noteuser - Password: (from .env)
- WiFi: (your network name)
- URL:
- Test connection โ Enable auto-sync
- Done! ๐
โก๏ธ Detailed guide: QUICKSTART.md
๐ Documentation
| Document | Content |
|---|---|
| QUICKSTART.md | Step-by-step installation |
| FEATURES.md | Complete feature list |
| BACKUP.md | Backup & restore guide |
| DESKTOP.md | Desktop integration (Markdown) |
| Simple Notes Desktop | Desktop editor for Windows & Linux (beta) ๐ป |
| SELF_SIGNED_SSL.md | Self-signed SSL certificate setup |
| DOCS.md | Technical details & troubleshooting |
| CHANGELOG.md | Version history |
| UPCOMING.md | Upcoming features ๐ |
| TRANSLATING.md | Translation guide ๐ |
๐ ๏ธ Development
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:
- Check existing discussions to see if someone already suggested it
- If not, start a new discussion in the "Feature Requests / Ideas" category
- 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! ๐
๐ค Contributing
Contributions welcome! See CONTRIBUTING.md
If you find this app useful, you can support its development:
๐ License
GNU Affero General Public License v3.0 - see LICENSE
v2.14.0 ยท Built with โค๏ธ using Kotlin + Jetpack Compose + Material Design 3


