Logo

Simple Notes Sync

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

[![Android](https://img.shields.io/badge/Android-8.0%2B-3DDC84?style=for-the-badge&logo=android&logoColor=white)](https://www.android.com/) [![Kotlin](https://img.shields.io/badge/Kotlin-7F52FF?style=for-the-badge&logo=kotlin&logoColor=white)](https://kotlinlang.org/) [![Jetpack Compose](https://img.shields.io/badge/Jetpack%20Compose-4285F4?style=for-the-badge&logo=jetpackcompose&logoColor=white)](https://developer.android.com/compose/) [![Material 3](https://img.shields.io/badge/Material_3-6750A4?style=for-the-badge&logo=material-design&logoColor=white)](https://m3.material.io/) [![License](https://img.shields.io/badge/License-MIT-F5C400?style=for-the-badge)](LICENSE)
Get it on IzzyOnDroid Get it on Obtainium Get it on F-Droid
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](https://github.com/inventory69/simple-notes-sync/releases/latest) ยท [๐Ÿ“– Documentation](docs/DOCS.md) ยท [๐Ÿš€ Quick Start](QUICKSTART.md)
**๐ŸŒ** [Deutsch](README.de.md) ยท **English**
## ๐Ÿ“ฑ Screenshots

Sync status Edit note Edit checklist Settings Server settings Sync settings

๐Ÿ“ Offline-first  โ€ข  ๐Ÿ”„ Smart Sync  โ€ข  ๐Ÿ”’ Self-hosted  โ€ข  ๐Ÿ”‹ Battery-friendly
## โœจ Highlights - ๐Ÿ“ **Offline-first** - Works without internet - ๐Ÿ“Š **Flexible views** - Switch between list and grid layout - โœ… **Checklists** - Tap-to-check, drag & drop - ๐ŸŒ **Multilingual** - English/German with language selector - ๐Ÿ”„ **Configurable sync triggers** - onSave, onResume, WiFi-connect, periodic (15/30/60 min), boot - ๐Ÿ”’ **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 - ๐Ÿ”‹ **Battery-friendly** - ~0.2% with defaults, up to ~1.0% with periodic sync - ๐ŸŽจ **Material Design 3** - Dynamic dark/light mode & colors based on system settings โžก๏ธ **Complete feature list:** [FEATURES.md](docs/FEATURES.md) ## ๐Ÿš€ Quick Start ### 1. Server Setup (5 minutes) ```bash 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](server/README.md) ### 2. App Installation (2 minutes) 1. [Download APK](https://github.com/inventory69/simple-notes-sync/releases/latest) 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](QUICKSTART.md) ## ๐Ÿ“š Documentation | Document | Content | |----------|---------| | **[QUICKSTART.md](QUICKSTART.md)** | Step-by-step installation | | **[FEATURES.md](docs/FEATURES.md)** | Complete feature list | | **[BACKUP.md](docs/BACKUP.md)** | Backup & restore guide | | **[DESKTOP.md](docs/DESKTOP.md)** | Desktop integration (Markdown) | | **[SELF_SIGNED_SSL.md](docs/SELF_SIGNED_SSL.md)** | Self-signed SSL certificate setup | | **[DOCS.md](docs/DOCS.md)** | Technical details & troubleshooting | | **[CHANGELOG.md](CHANGELOG.md)** | Version history | | **[UPCOMING.md](docs/UPCOMING.md)** | Upcoming features ๐Ÿš€ | | **[TRANSLATING.md](docs/TRANSLATING.md)** | Translation guide ๐ŸŒ | ```bash cd android ./gradlew assembleStandardRelease ``` โžก๏ธ **Build guide:** [DOCS.md](docs/DOCS.md#-build--deployment) ## ๐Ÿค Contributing Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) ## ๐Ÿ“„ License MIT License - see [LICENSE](LICENSE)


**v1.7.0** ยท Built with โค๏ธ using Kotlin + Jetpack Compose + Material Design 3