a96d373e78
- New: Grid view for notes – thanks to freemen - New: WiFi-only sync toggle in settings - New: Encryption for local backups – thanks to @SilentCoderHere (ref #9) - Fixed: Sync now works correctly when VPN is active – thanks to @roughnecks (closes #11) - Improved: Server change now resets sync status for all notes - Improved: 'Sync already running' feedback for additional executions - Various bug fixes and UI improvements - Added support for self-signed SSL certificates; documentation updated – thanks to Stefan L. - SHA-256 hash of the signing certificate is now shown in the README and on release pages – thanks to @isawaway (ref #10) This release brings enhanced security, better sync reliability, and improved usability for self-hosted and private server setups.
144 lines
5.7 KiB
Markdown
144 lines
5.7 KiB
Markdown
<div align="center">
|
||
<img src="android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png" alt="Logo" />
|
||
</div>
|
||
|
||
<h1 align="center">Simple Notes Sync</h1>
|
||
|
||
<h4 align="center">Minimalistische Offline-Notizen mit intelligentem Sync - Einfachheit trifft smarte Synchronisation.</h4>
|
||
|
||
<div align="center">
|
||
|
||
[](https://www.android.com/)
|
||
[](https://kotlinlang.org/)
|
||
[](https://developer.android.com/compose/)
|
||
[](https://m3.material.io/)
|
||
[](LICENSE)
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
<a href="https://apt.izzysoft.de/fdroid/index/apk/dev.dettmer.simplenotes">
|
||
<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png"
|
||
alt="Get it on IzzyOnDroid" align="center" height="80" /></a>
|
||
|
||
<a href="https://apps.obtainium.imranr.dev/redirect.html?r=obtainium://add/https://github.com/inventory69/simple-notes-sync">
|
||
<img src="https://github.com/ImranR98/Obtainium/blob/main/assets/graphics/badge_obtainium.png"
|
||
alt="Get it on Obtainium" align="center" height="54" />
|
||
</a>
|
||
|
||
<a href="https://f-droid.org/packages/dev.dettmer.simplenotes">
|
||
<img src="https://f-droid.org/badge/get-it-on.png"
|
||
alt="Get it on F-Droid" align="center" height="80" /></a>
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
<strong>SHA-256 Hash des Signaturzertifikats:</strong><br /> 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
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
<br />[📱 APK Download](https://github.com/inventory69/simple-notes-sync/releases/latest) · [📖 Dokumentation](docs/DOCS.de.md) · [🚀 Schnellstart](QUICKSTART.de.md)<br />
|
||
**🌍** Deutsch · [English](README.md)
|
||
|
||
</div>
|
||
|
||
## 📱 Screenshots
|
||
|
||
<p align="center">
|
||
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/1.png" width="250" alt="Sync status">
|
||
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/2.png" width="250" alt="Edit note">
|
||
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/3.png" width="250" alt="Edit checklist">
|
||
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/4.png" width="250" alt="Settings">
|
||
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/5.png" width="250" alt="Server settings">
|
||
<img src="fastlane/metadata/android/de-DE/images/phoneScreenshots/7.png" width="250" alt="Sync settings">
|
||
</p>
|
||
|
||
<div align="center">
|
||
|
||
📝 Offline-first • 🔄 Smart Sync • 🔒 Self-hosted • 🔋 Akkuschonend
|
||
|
||
</div>
|
||
|
||
## ✨ Highlights
|
||
|
||
- 📝 **Offline-first** – Funktioniert ohne Internet
|
||
- 📊 **Flexible Ansichten** – Listen- und Grid-Layout
|
||
- ✅ **Checklisten** – Tap-to-Check, Drag & Drop
|
||
- 🌍 **Mehrsprachig** – Deutsch/Englisch mit Sprachauswahl
|
||
- 🔄 **Konfigurierbare Sync-Trigger** – onSave, onResume, WiFi, periodisch (15/30/60 Min), Boot
|
||
- 🔒 **Self-hosted** – Deine Daten bleiben bei dir (WebDAV)
|
||
- 💾 **Lokales Backup** – Export/Import als JSON-Datei (optional verschlüsselt)
|
||
- 🖥️ **Desktop-Integration** – Markdown-Export für Obsidian, VS Code, Typora
|
||
- 🔋 **Akkuschonend** – ~0.2% mit Defaults, bis zu ~1.0% mit Periodic Sync
|
||
- 🎨 **Material Design 3** – Dynamischer Dark/Light Mode & Farben
|
||
|
||
➡️ **Vollständige Feature-Liste:** [docs/FEATURES.de.md](docs/FEATURES.de.md)
|
||
|
||
## 🚀 Schnellstart
|
||
|
||
### 1. Server Setup (5 Minuten)
|
||
|
||
```bash
|
||
git clone https://github.com/inventory69/simple-notes-sync.git
|
||
cd simple-notes-sync/server
|
||
cp .env.example .env
|
||
# Passwort in .env setzen
|
||
docker compose up -d
|
||
```
|
||
|
||
➡️ **Details:** [Server Setup Guide](server/README.de.md)
|
||
|
||
### 2. App Installation (2 Minuten)
|
||
|
||
1. [APK herunterladen](https://github.com/inventory69/simple-notes-sync/releases/latest)
|
||
2. Installieren & öffnen
|
||
3. ⚙️ Einstellungen → Server konfigurieren:
|
||
- **URL:** `http://DEINE-SERVER-IP:8080/` _(nur Base-URL!)_
|
||
- **User:** `noteuser`
|
||
- **Passwort:** _(aus .env)_
|
||
- **WLAN:** _(dein Netzwerk-Name)_
|
||
4. **Verbindung testen** → Auto-Sync aktivieren
|
||
5. Fertig! 🎉
|
||
|
||
➡️ **Ausführliche Anleitung:** [QUICKSTART.de.md](QUICKSTART.de.md)
|
||
|
||
## 📚 Dokumentation
|
||
|
||
| Dokument | Inhalt |
|
||
|----------|--------|
|
||
| **[QUICKSTART.de.md](QUICKSTART.de.md)** | Schritt-für-Schritt Installation |
|
||
| **[FEATURES.de.md](docs/FEATURES.de.md)** | Vollständige Feature-Liste |
|
||
| **[BACKUP.de.md](docs/BACKUP.de.md)** | Backup & Wiederherstellung |
|
||
| **[DESKTOP.de.md](docs/DESKTOP.de.md)** | Desktop-Integration (Markdown) |
|
||
| **[SELF_SIGNED_SSL.md](docs/SELF_SIGNED_SSL.md)** | Self-signed SSL Zertifikat Setup |
|
||
| **[DOCS.de.md](docs/DOCS.de.md)** | Technische Details & Troubleshooting |
|
||
| **[CHANGELOG.de.md](CHANGELOG.de.md)** | Versionshistorie |
|
||
| **[UPCOMING.de.md](docs/UPCOMING.de.md)** | Geplante Features 🚀 |
|
||
| **[ÜBERSETZEN.md](docs/TRANSLATING.de.md)** | Übersetzungsanleitung 🌍 |
|
||
|
||
## 🛠️ Entwicklung
|
||
|
||
```bash
|
||
cd android
|
||
./gradlew assembleStandardRelease
|
||
```
|
||
|
||
➡️ **Build-Anleitung:** [docs/DOCS.de.md#-build--deployment](docs/DOCS.de.md#-build--deployment)
|
||
|
||
## 🤝 Contributing
|
||
|
||
Beiträge willkommen! Siehe [CONTRIBUTING.md](CONTRIBUTING.md)
|
||
|
||
## 📄 Lizenz
|
||
|
||
MIT License – siehe [LICENSE](LICENSE)
|
||
|
||
<div align="center">
|
||
<br /><br />
|
||
|
||
**v1.7.0** · Built with ❤️ using Kotlin + Jetpack Compose + Material Design 3
|
||
|
||
</div>
|