simple-notes-sync/README.en.md

Simple Notes Sync 📝

Minimalist offline notes with auto-sync to your own server

📱 APK Download · 📖 Documentation · 🚀 Quick Start

🌍 Languages: Deutsch · English

---

📱 Screenshots

---

Features

📝 Notes

• Simple text notes with auto-save
• Swipe-to-delete with confirmation
• Material Design 3 editor

🔄 Synchronization

• Pull-to-refresh for manual sync
• Auto-sync (15/30/60 min) only on home WiFi
• Smart server check - No errors on foreign networks
• Conflict-free merging - Your changes are never lost

🔒 Privacy & Self-Hosted

• WebDAV server (Nextcloud, ownCloud, etc.)
• Docker setup guide included in docs
• Your data stays with you - No tracking, no cloud
• HTTP only local - HTTPS for external servers
• 100% open source (MIT License)

🔋 Performance

• Battery-friendly (~0.2-0.8% per day)
• Offline-first - Works without internet
• Dark mode & dynamic colors

---

🚀 Quick Start

1. Server Setup

cd server
cp .env.example .env
# Set password in .env
docker compose up -d

➡️ Details: Server Setup Guide

2. App Installation

1. Download APK
2. Install & open
3. ⚙️ Settings → Configure server
4. Enable auto-sync

➡️ Details: Complete guide

---

📚 Documentation

• Quick Start Guide - Step-by-step guide for end users
• Server Setup - Configure WebDAV server
• Complete Docs - Features, troubleshooting, build instructions

---

🛠️ Development

cd android
./gradlew assembleStandardRelease

➡️ Details: Build instructions in DOCS.en.md

---

🤝 Contributing

Contributions are welcome! See CONTRIBUTING.md for details.

---

📄 License

MIT License - see LICENSE

v1.1.2 · Built with Kotlin + Material Design 3