Simple Notes Sync
Clean, offline-first notes with intelligent sync - simplicity meets smart synchronization.
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
๐ 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
