Update project plan with detailed decisions and markdown format
Key changes: - Changed data format to Markdown files with YAML frontmatter (Obsidian-compatible) - Removed timeline estimates from all phases - Added comprehensive UI framework analysis (bevy_ui vs bevy_egui) - Added detailed authentication options for WebDAV (keychain recommended) - Expanded distribution strategy to include all app stores (F-Droid, Flathub, etc.) - Clarified backup strategy as user-managed via external tools - Removed success metrics section - Added markdown benefits: human-readable, git-friendly, tool-compatible Decisions made: - Recommend pure bevy_ui for performance and future game-like polish - Use platform keychain (keyring crate) for WebDAV credentials - Users handle backups via git, cloud storage, or other external tools 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
aefcae5516
commit
219516e863
359
PLAN.md
359
PLAN.md
|
|
@ -26,7 +26,8 @@ A local-first, cross-platform tasks application inspired by Google Tasks, built
|
||||||
|
|
||||||
### Data Storage Layer
|
### Data Storage Layer
|
||||||
- **serde**: Serialization/deserialization
|
- **serde**: Serialization/deserialization
|
||||||
- **serde_json** or **rmp-serde**: JSON or MessagePack for task data
|
- **pulldown-cmark** or **markdown**: Markdown parsing
|
||||||
|
- **gray_matter** or **yaml-rust**: YAML frontmatter parsing (Obsidian-style metadata)
|
||||||
- **directories**: Cross-platform path handling
|
- **directories**: Cross-platform path handling
|
||||||
- **tokio**: Async runtime for I/O operations
|
- **tokio**: Async runtime for I/O operations
|
||||||
- **reqwest** + **dav-client**: WebDAV support
|
- **reqwest** + **dav-client**: WebDAV support
|
||||||
|
|
@ -46,22 +47,46 @@ A local-first, cross-platform tasks application inspired by Google Tasks, built
|
||||||
|
|
||||||
### Data Model
|
### Data Model
|
||||||
|
|
||||||
|
Tasks are stored as individual `.md` (Markdown) files, with metadata in YAML frontmatter (Obsidian-compatible format).
|
||||||
|
|
||||||
```
|
```
|
||||||
|
Task File Format (my-task-name.md):
|
||||||
|
---
|
||||||
|
id: 550e8400-e29b-41d4-a716-446655440000
|
||||||
|
status: in-progress
|
||||||
|
due: 2025-11-15T14:00:00Z
|
||||||
|
created: 2025-10-26T10:00:00Z
|
||||||
|
updated: 2025-10-26T12:30:00Z
|
||||||
|
parent: 550e8400-e29b-41d4-a716-446655440001
|
||||||
|
position: 1
|
||||||
|
tags: [work, urgent]
|
||||||
|
---
|
||||||
|
|
||||||
|
Task description and notes go here in **markdown** format.
|
||||||
|
|
||||||
|
- Can include lists
|
||||||
|
- Rich formatting
|
||||||
|
- Links, etc.
|
||||||
|
```
|
||||||
|
|
||||||
|
**In-Memory Model**:
|
||||||
|
```rust
|
||||||
Task {
|
Task {
|
||||||
id: Uuid,
|
id: Uuid,
|
||||||
title: String,
|
title: String, // Derived from filename
|
||||||
notes: Option<String>,
|
notes: String, // Markdown content
|
||||||
status: TaskStatus, // NotStarted, InProgress, Completed
|
status: TaskStatus, // From frontmatter
|
||||||
due_date: Option<DateTime>,
|
due_date: Option<DateTime>, // From frontmatter
|
||||||
created_at: DateTime,
|
created_at: DateTime, // From frontmatter
|
||||||
updated_at: DateTime,
|
updated_at: DateTime, // From frontmatter
|
||||||
parent_id: Option<Uuid>, // For subtasks
|
parent_id: Option<Uuid>, // From frontmatter
|
||||||
position: i32, // For ordering
|
position: i32, // From frontmatter
|
||||||
|
tags: Vec<String>, // From frontmatter
|
||||||
}
|
}
|
||||||
|
|
||||||
TaskList {
|
TaskList {
|
||||||
id: Uuid,
|
id: Uuid,
|
||||||
title: String,
|
title: String, // Derived from folder name
|
||||||
tasks: Vec<Task>,
|
tasks: Vec<Task>,
|
||||||
created_at: DateTime,
|
created_at: DateTime,
|
||||||
updated_at: DateTime,
|
updated_at: DateTime,
|
||||||
|
|
@ -121,23 +146,38 @@ bevy-tasks/
|
||||||
### Storage Strategy
|
### Storage Strategy
|
||||||
|
|
||||||
#### Local Storage
|
#### Local Storage
|
||||||
- **Location**: Platform-specific app data directory
|
- **Location**: User-selectable folder OR platform-specific app data directory
|
||||||
- Windows: `%APPDATA%/bevy-tasks/`
|
- Windows: `%APPDATA%/bevy-tasks/` (default)
|
||||||
- Linux: `~/.local/share/bevy-tasks/`
|
- Linux: `~/.local/share/bevy-tasks/` (default)
|
||||||
- macOS: `~/Library/Application Support/bevy-tasks/`
|
- macOS: `~/Library/Application Support/bevy-tasks/` (default)
|
||||||
- iOS: App sandbox documents directory
|
- iOS: App sandbox documents directory
|
||||||
- Android: Internal storage app directory
|
- Android: Internal storage app directory
|
||||||
- **Format**: JSON files (human-readable, debuggable)
|
- User can select any folder with read/write permissions
|
||||||
|
- **Format**: Markdown files with YAML frontmatter (Obsidian-compatible)
|
||||||
- **Structure**:
|
- **Structure**:
|
||||||
```
|
```
|
||||||
data/
|
data/
|
||||||
├── config.json
|
├── .bevy-tasks/
|
||||||
├── lists/
|
│ ├── config.json # App configuration
|
||||||
│ ├── {list-id-1}.json
|
│ └── metadata.json # List ordering, sync state
|
||||||
│ └── {list-id-2}.json
|
├── My Tasks/ # Task list folder
|
||||||
└── metadata.json
|
│ ├── Buy groceries.md
|
||||||
|
│ ├── Call dentist.md
|
||||||
|
│ └── Project X/ # Subtask folder (optional)
|
||||||
|
│ └── Design mockup.md
|
||||||
|
└── Work/ # Another task list
|
||||||
|
├── Review PRs.md
|
||||||
|
└── Team meeting prep.md
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Benefits of Markdown Format**:
|
||||||
|
- Human-readable and editable in any text editor
|
||||||
|
- Compatible with Obsidian, Logseq, and other markdown tools
|
||||||
|
- Easy to version control (git-friendly)
|
||||||
|
- Future-proof format
|
||||||
|
- Enables external editing and scripting
|
||||||
|
- Natural organization with folders
|
||||||
|
|
||||||
#### WebDAV Sync
|
#### WebDAV Sync
|
||||||
- **Conflict Resolution**: Last-write-wins with timestamp
|
- **Conflict Resolution**: Last-write-wins with timestamp
|
||||||
- **Sync Strategy**:
|
- **Sync Strategy**:
|
||||||
|
|
@ -170,87 +210,96 @@ bevy-tasks/
|
||||||
|
|
||||||
## Feature Roadmap
|
## Feature Roadmap
|
||||||
|
|
||||||
### Phase 1: MVP (Weeks 1-4)
|
### Phase 1: MVP
|
||||||
**Goal**: Basic local-first tasks app on desktop platforms
|
**Goal**: Basic local-first tasks app on desktop platforms
|
||||||
|
|
||||||
**Features**:
|
**Features**:
|
||||||
- [ ] Single task list
|
- [ ] Single task list
|
||||||
- [ ] Create, read, update, delete tasks
|
- [ ] Create, read, update, delete tasks
|
||||||
- [ ] Mark tasks as complete/incomplete
|
- [ ] Mark tasks as complete/incomplete
|
||||||
- [ ] Local file storage (JSON)
|
- [ ] Local file storage (Markdown files)
|
||||||
|
- [ ] Markdown parsing with YAML frontmatter
|
||||||
- [ ] Basic UI (list view)
|
- [ ] Basic UI (list view)
|
||||||
- [ ] Desktop support (Windows, Linux, macOS)
|
- [ ] Desktop support (Windows, Linux, macOS)
|
||||||
|
|
||||||
**Deliverables**:
|
**Deliverables**:
|
||||||
- Functional desktop app
|
- Functional desktop app
|
||||||
- Data persists across sessions
|
- Data persists across sessions as .md files
|
||||||
- Sub-second startup time
|
- Sub-second startup time
|
||||||
|
|
||||||
### Phase 2: Multiple Lists & Organization (Weeks 5-6)
|
### Phase 2: Multiple Lists & Organization
|
||||||
**Goal**: Feature parity with basic Google Tasks functionality
|
**Goal**: Feature parity with basic Google Tasks functionality
|
||||||
|
|
||||||
**Features**:
|
**Features**:
|
||||||
- [ ] Multiple task lists
|
- [ ] Multiple task lists (folders)
|
||||||
- [ ] Switch between lists
|
- [ ] Switch between lists
|
||||||
- [ ] Subtasks support
|
- [ ] Subtasks support (nested folders or parent_id)
|
||||||
- [ ] Due dates
|
- [ ] Due dates (frontmatter metadata)
|
||||||
- [ ] Task notes/descriptions
|
- [ ] Task notes/descriptions (markdown content)
|
||||||
- [ ] Reorder tasks (drag & drop)
|
- [ ] Reorder tasks (drag & drop, updates position)
|
||||||
- [ ] Move tasks between lists
|
- [ ] Move tasks between lists (move .md files)
|
||||||
|
- [ ] Folder picker for custom storage location
|
||||||
|
|
||||||
**Deliverables**:
|
**Deliverables**:
|
||||||
- Full task management functionality
|
- Full task management functionality
|
||||||
- Improved UI/UX
|
- Improved UI/UX
|
||||||
|
- Obsidian-compatible file format
|
||||||
|
|
||||||
### Phase 3: WebDAV Sync (Weeks 7-9)
|
### Phase 3: WebDAV Sync
|
||||||
**Goal**: Enable cross-device synchronization
|
**Goal**: Enable cross-device synchronization
|
||||||
|
|
||||||
**Features**:
|
**Features**:
|
||||||
- [ ] WebDAV client implementation
|
- [ ] WebDAV client implementation
|
||||||
- [ ] Settings screen for storage configuration
|
- [ ] Settings screen for storage configuration
|
||||||
|
- [ ] Credential storage (see Authentication section)
|
||||||
- [ ] Sync status indicators
|
- [ ] Sync status indicators
|
||||||
- [ ] Conflict resolution
|
- [ ] Conflict resolution (last-write-wins with manual review option)
|
||||||
- [ ] Offline mode with queue
|
- [ ] Offline mode with queue
|
||||||
- [ ] Manual sync trigger
|
- [ ] Manual sync trigger
|
||||||
|
- [ ] Bi-directional sync of .md files
|
||||||
|
|
||||||
**Deliverables**:
|
**Deliverables**:
|
||||||
- Working WebDAV sync
|
- Working WebDAV sync
|
||||||
- Reliable conflict resolution
|
- Reliable conflict resolution
|
||||||
- Seamless offline/online transitions
|
- Seamless offline/online transitions
|
||||||
|
|
||||||
### Phase 4: Mobile Support (Weeks 10-14)
|
### Phase 4: Mobile Support
|
||||||
**Goal**: Deploy to iOS and Android
|
**Goal**: Deploy to iOS and Android
|
||||||
|
|
||||||
**Features**:
|
**Features**:
|
||||||
- [ ] Touch-optimized UI
|
- [ ] Touch-optimized UI
|
||||||
- [ ] iOS build pipeline
|
- [ ] iOS build pipeline
|
||||||
- [ ] Android build pipeline
|
- [ ] Android build pipeline
|
||||||
- [ ] Mobile-specific UX (swipe gestures, etc.)
|
- [ ] Mobile-specific UX (swipe gestures, pull-to-refresh)
|
||||||
- [ ] Background sync on mobile
|
- [ ] Background sync on mobile
|
||||||
- [ ] Push notifications (optional)
|
- [ ] Mobile file system integration
|
||||||
|
- [ ] Share extension (share to tasks)
|
||||||
|
|
||||||
**Deliverables**:
|
**Deliverables**:
|
||||||
- Working iOS app
|
- Working iOS app
|
||||||
- Working Android app
|
- Working Android app
|
||||||
- Consistent UX across mobile and desktop
|
- Consistent UX across mobile and desktop
|
||||||
|
|
||||||
### Phase 5: Polish & Advanced Features (Weeks 15+)
|
### Phase 5: Polish & Advanced Features
|
||||||
**Goal**: Differentiate from Google Tasks, leverage Bevy's capabilities
|
**Goal**: Differentiate from Google Tasks, leverage Bevy's capabilities
|
||||||
|
|
||||||
**Features**:
|
**Features**:
|
||||||
- [ ] Themes and customization
|
- [ ] Themes and customization
|
||||||
- [ ] Advanced animations
|
- [ ] Advanced animations and transitions
|
||||||
- [ ] Keyboard shortcuts
|
- [ ] Keyboard shortcuts
|
||||||
- [ ] Search and filters
|
- [ ] Full-text search across tasks
|
||||||
|
- [ ] Filters and smart lists
|
||||||
- [ ] Task templates
|
- [ ] Task templates
|
||||||
- [ ] Recurring tasks
|
- [ ] Recurring tasks
|
||||||
- [ ] Statistics and insights
|
- [ ] Statistics and insights
|
||||||
- [ ] Game-like achievement system (optional)
|
- [ ] Game-like achievement system (optional)
|
||||||
- [ ] Custom UI skins
|
- [ ] Custom UI skins
|
||||||
|
- [ ] Plugin system for extensions
|
||||||
|
|
||||||
**Deliverables**:
|
**Deliverables**:
|
||||||
- Polished, delightful UX
|
- Polished, delightful UX
|
||||||
- Unique features not in Google Tasks
|
- Unique features not in Google Tasks
|
||||||
|
- Distribution to all app stores
|
||||||
|
|
||||||
## Development Guidelines
|
## Development Guidelines
|
||||||
|
|
||||||
|
|
@ -270,9 +319,22 @@ bevy-tasks/
|
||||||
|
|
||||||
### Build & Release
|
### Build & Release
|
||||||
- **CI/CD**: GitHub Actions for all platforms
|
- **CI/CD**: GitHub Actions for all platforms
|
||||||
- **Desktop**: Direct downloads (AppImage, DMG, MSI)
|
- **Initial Distribution**:
|
||||||
- **Mobile**: App Store and Google Play
|
- **Desktop**: Direct downloads and sideloading
|
||||||
|
- Linux: AppImage, .tar.gz
|
||||||
|
- macOS: DMG
|
||||||
|
- Windows: MSI, portable .exe
|
||||||
|
- **Mobile**: Sideloading only
|
||||||
|
- iOS: .ipa for TestFlight/direct install
|
||||||
|
- Android: .apk
|
||||||
|
- **Future Distribution Channels** (Phase 5+):
|
||||||
|
- **F-Droid**: FOSS Android app store
|
||||||
|
- **Flathub**: Linux Flatpak repository
|
||||||
|
- **Google Play Store**: Android
|
||||||
|
- **Apple App Store**: iOS and macOS
|
||||||
|
- **Microsoft Store**: Windows
|
||||||
- **Version scheme**: Semantic versioning (0.1.0 → 1.0.0)
|
- **Version scheme**: Semantic versioning (0.1.0 → 1.0.0)
|
||||||
|
- **Release notes**: Auto-generated from commits
|
||||||
|
|
||||||
## Technical Challenges & Solutions
|
## Technical Challenges & Solutions
|
||||||
|
|
||||||
|
|
@ -299,7 +361,7 @@ bevy-tasks/
|
||||||
|
|
||||||
**Solutions**:
|
**Solutions**:
|
||||||
- Implement robust retry logic with exponential backoff
|
- Implement robust retry logic with exponential backoff
|
||||||
- Cache credentials securely (use platform keychains)
|
- Cache credentials securely (see Authentication Options below)
|
||||||
- Queue operations when offline
|
- Queue operations when offline
|
||||||
- Provide clear sync status to user
|
- Provide clear sync status to user
|
||||||
- Support multiple WebDAV servers (Nextcloud, ownCloud, etc.)
|
- Support multiple WebDAV servers (Nextcloud, ownCloud, etc.)
|
||||||
|
|
@ -308,27 +370,11 @@ bevy-tasks/
|
||||||
**Problem**: Schema changes need to preserve user data
|
**Problem**: Schema changes need to preserve user data
|
||||||
|
|
||||||
**Solutions**:
|
**Solutions**:
|
||||||
- Version data format from day one
|
- Version frontmatter schema from day one
|
||||||
- Write migration scripts for each version bump
|
- Write migration scripts for each version bump
|
||||||
- Test migrations with real user data
|
- Markdown format is naturally forward/backward compatible
|
||||||
- Backup before migration
|
- Users handle their own backups (external to app)
|
||||||
|
- Migration can be done in-place by updating frontmatter
|
||||||
## Success Metrics
|
|
||||||
|
|
||||||
### Performance
|
|
||||||
- ✓ Startup time < 500ms on mid-range devices
|
|
||||||
- ✓ 60 FPS UI on all platforms
|
|
||||||
- ✓ Handle 10,000+ tasks without performance degradation
|
|
||||||
|
|
||||||
### User Experience
|
|
||||||
- ✓ Task creation in < 3 taps/clicks
|
|
||||||
- ✓ Zero data loss
|
|
||||||
- ✓ Sync conflicts rare and auto-resolved
|
|
||||||
|
|
||||||
### Platform Support
|
|
||||||
- ✓ All 5 platforms working
|
|
||||||
- ✓ Consistent feature set across platforms
|
|
||||||
- ✓ Native feel on each platform
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
|
|
@ -338,6 +384,8 @@ bevy-tasks/
|
||||||
bevy = "0.16"
|
bevy = "0.16"
|
||||||
serde = { version = "1.0", features = ["derive"] }
|
serde = { version = "1.0", features = ["derive"] }
|
||||||
serde_json = "1.0"
|
serde_json = "1.0"
|
||||||
|
serde_yaml = "0.9" # For frontmatter parsing
|
||||||
|
pulldown-cmark = "0.9" # Markdown parsing
|
||||||
uuid = { version = "1.0", features = ["serde", "v4"] }
|
uuid = { version = "1.0", features = ["serde", "v4"] }
|
||||||
chrono = { version = "0.4", features = ["serde"] }
|
chrono = { version = "0.4", features = ["serde"] }
|
||||||
directories = "5.0"
|
directories = "5.0"
|
||||||
|
|
@ -348,6 +396,9 @@ anyhow = "1.0"
|
||||||
reqwest = { version = "0.11", features = ["json"] }
|
reqwest = { version = "0.11", features = ["json"] }
|
||||||
# Note: Evaluate dav-client alternatives
|
# Note: Evaluate dav-client alternatives
|
||||||
|
|
||||||
|
# Credential storage (see Authentication Options)
|
||||||
|
keyring = "2.0" # Cross-platform keychain access
|
||||||
|
|
||||||
# Platform-specific
|
# Platform-specific
|
||||||
[target.'cfg(target_os = "android")'.dependencies]
|
[target.'cfg(target_os = "android")'.dependencies]
|
||||||
# Android-specific deps
|
# Android-specific deps
|
||||||
|
|
@ -386,13 +437,185 @@ cargo apk build --release
|
||||||
cargo build --target aarch64-apple-ios --release
|
cargo build --target aarch64-apple-ios --release
|
||||||
```
|
```
|
||||||
|
|
||||||
## Questions & Decisions Needed
|
## Questions & Decisions
|
||||||
|
|
||||||
1. **UI Framework**: Pure bevy_ui or bevy_egui for complex widgets?
|
### 1. UI Framework: bevy_ui vs bevy_egui
|
||||||
2. **Data Format**: JSON (human-readable) or MessagePack (efficient)?
|
|
||||||
3. **Authentication**: How to securely store WebDAV credentials?
|
#### Option A: Pure bevy_ui
|
||||||
4. **Distribution**: Self-hosted only or aim for app stores?
|
**Pros**:
|
||||||
5. **Backup Strategy**: Automatic local backups? Export functionality?
|
- Native to Bevy, no additional dependencies
|
||||||
|
- Full control over rendering and styling
|
||||||
|
- Better performance (no intermediate UI layer)
|
||||||
|
- Fits Bevy's ECS paradigm perfectly
|
||||||
|
- More flexibility for game-like UX polish later
|
||||||
|
- Smaller binary size
|
||||||
|
- Consistent cross-platform look
|
||||||
|
|
||||||
|
**Cons**:
|
||||||
|
- More verbose, lower-level API
|
||||||
|
- Need to build complex widgets from scratch
|
||||||
|
- Text input handling requires more work
|
||||||
|
- Fewer built-in widgets
|
||||||
|
- Steeper learning curve for complex layouts
|
||||||
|
- More code to maintain
|
||||||
|
|
||||||
|
**Best for**: If you want maximum performance, full control, and are willing to invest time building custom widgets.
|
||||||
|
|
||||||
|
#### Option B: bevy_egui
|
||||||
|
**Pros**:
|
||||||
|
- Rich set of built-in widgets (text input, combo boxes, etc.)
|
||||||
|
- Immediate mode GUI is simple to reason about
|
||||||
|
- Rapid prototyping and iteration
|
||||||
|
- Good text editing support out of the box
|
||||||
|
- Mature ecosystem
|
||||||
|
- Less code for standard UI patterns
|
||||||
|
- Better accessibility features
|
||||||
|
|
||||||
|
**Cons**:
|
||||||
|
- Additional dependency (~500KB+)
|
||||||
|
- Slight performance overhead
|
||||||
|
- Less control over rendering
|
||||||
|
- Immediate mode pattern conflicts with ECS
|
||||||
|
- Harder to achieve game-like polish
|
||||||
|
- Less Bevy-native feel
|
||||||
|
- More challenging to customize appearance
|
||||||
|
|
||||||
|
**Best for**: If you want to ship quickly with standard UI widgets and don't need deep customization.
|
||||||
|
|
||||||
|
#### Option C: Hybrid Approach
|
||||||
|
Use **bevy_ui** for primary interface (task lists, main views) and **bevy_egui** for complex forms and settings screens.
|
||||||
|
|
||||||
|
**Pros**:
|
||||||
|
- Best of both worlds
|
||||||
|
- Use right tool for each job
|
||||||
|
- Fast development where needed, optimized where it matters
|
||||||
|
|
||||||
|
**Cons**:
|
||||||
|
- Two UI systems to learn and maintain
|
||||||
|
- Increased binary size
|
||||||
|
- Inconsistent look without careful styling
|
||||||
|
|
||||||
|
#### Recommendation
|
||||||
|
Start with **pure bevy_ui** for MVP. The task list UI is relatively simple (lists, buttons, text), and this gives you:
|
||||||
|
- Maximum performance for fast startup
|
||||||
|
- Foundation for future game-like polish
|
||||||
|
- Full control over mobile UX
|
||||||
|
|
||||||
|
Reserve bevy_egui as a fallback if text editing becomes too complex to implement.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. Authentication Options for WebDAV
|
||||||
|
|
||||||
|
#### Option A: Platform Keychain/Keyring
|
||||||
|
**Implementation**: Use `keyring` crate for cross-platform credential storage
|
||||||
|
|
||||||
|
**Pros**:
|
||||||
|
- Most secure option
|
||||||
|
- OS-managed encryption
|
||||||
|
- Follows platform security best practices
|
||||||
|
- Auto-locks with system
|
||||||
|
- Works on all platforms:
|
||||||
|
- Windows: Credential Manager
|
||||||
|
- macOS: Keychain
|
||||||
|
- Linux: Secret Service API (gnome-keyring/kwallet)
|
||||||
|
- iOS: Keychain
|
||||||
|
- Android: Keystore
|
||||||
|
|
||||||
|
**Cons**:
|
||||||
|
- Requires user to unlock keychain
|
||||||
|
- May prompt for permissions
|
||||||
|
- Linux requires D-Bus and secret service
|
||||||
|
|
||||||
|
**Security**: ⭐⭐⭐⭐⭐
|
||||||
|
|
||||||
|
#### Option B: Encrypted Local Storage
|
||||||
|
**Implementation**: Encrypt credentials in config file using a master password or device key
|
||||||
|
|
||||||
|
**Pros**:
|
||||||
|
- Works offline always
|
||||||
|
- No external dependencies
|
||||||
|
- Full control over encryption
|
||||||
|
|
||||||
|
**Cons**:
|
||||||
|
- Need to manage encryption keys
|
||||||
|
- Vulnerable if key is compromised
|
||||||
|
- Need to prompt user for password
|
||||||
|
- Harder to implement correctly
|
||||||
|
|
||||||
|
**Security**: ⭐⭐⭐ (if done right)
|
||||||
|
|
||||||
|
#### Option C: App-Generated Token + Keychain
|
||||||
|
**Implementation**: User authenticates once via OAuth/app-specific password, store token in keychain
|
||||||
|
|
||||||
|
**Pros**:
|
||||||
|
- More secure than passwords
|
||||||
|
- Supports modern auth flows
|
||||||
|
- Can revoke tokens
|
||||||
|
- Works with Nextcloud, ownCloud app passwords
|
||||||
|
|
||||||
|
**Cons**:
|
||||||
|
- Requires OAuth flow implementation
|
||||||
|
- More complex initial setup
|
||||||
|
- Depends on server support
|
||||||
|
|
||||||
|
**Security**: ⭐⭐⭐⭐⭐
|
||||||
|
|
||||||
|
#### Option D: Store Username + Prompt for Password
|
||||||
|
**Implementation**: Store username in config, prompt for password on each sync
|
||||||
|
|
||||||
|
**Pros**:
|
||||||
|
- Simple implementation
|
||||||
|
- No credential storage
|
||||||
|
- Maximum security
|
||||||
|
|
||||||
|
**Cons**:
|
||||||
|
- Terrible UX
|
||||||
|
- Not practical for background sync
|
||||||
|
- Users will hate it
|
||||||
|
|
||||||
|
**Security**: ⭐⭐⭐⭐⭐ (but unusable)
|
||||||
|
|
||||||
|
#### Recommendation
|
||||||
|
**Primary**: Option A (Platform Keychain) using the `keyring` crate
|
||||||
|
- Store WebDAV username + password in system keychain
|
||||||
|
- Key: `com.bevy-tasks.webdav.{server-domain}`
|
||||||
|
- Graceful fallback if keychain is unavailable
|
||||||
|
|
||||||
|
**Fallback**: Option B (Encrypted storage) for platforms where keychain fails
|
||||||
|
- Use ChaCha20-Poly1305 for encryption
|
||||||
|
- Derive key from device identifier + app secret
|
||||||
|
|
||||||
|
**Future**: Option C (Token-based) for servers that support it
|
||||||
|
- Implement OAuth flow for Nextcloud/ownCloud
|
||||||
|
- Store tokens in keychain
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. Backup Strategy
|
||||||
|
|
||||||
|
**Decision**: User-managed backups via external tools
|
||||||
|
|
||||||
|
**Rationale**:
|
||||||
|
- Markdown format is already backup-friendly
|
||||||
|
- Users can use existing tools:
|
||||||
|
- Git for version control
|
||||||
|
- Dropbox/Google Drive/OneDrive for cloud backup
|
||||||
|
- Time Machine (macOS) / File History (Windows)
|
||||||
|
- rsync, rclone, etc.
|
||||||
|
- WebDAV itself serves as a backup when enabled
|
||||||
|
- Keeps app simple and focused
|
||||||
|
|
||||||
|
**App Responsibilities**:
|
||||||
|
- Don't corrupt data
|
||||||
|
- Write atomically (temp file + rename)
|
||||||
|
- Graceful handling of sync conflicts
|
||||||
|
- Clear documentation on backup best practices
|
||||||
|
|
||||||
|
**Optional Future Feature**:
|
||||||
|
- Export all tasks to single file (.zip of markdown)
|
||||||
|
- Import from backup
|
||||||
|
- Git integration for automatic versioning
|
||||||
|
|
||||||
## Resources
|
## Resources
|
||||||
|
|
||||||
|
|
@ -408,5 +631,5 @@ To be determined.
|
||||||
---
|
---
|
||||||
|
|
||||||
**Last Updated**: 2025-10-26
|
**Last Updated**: 2025-10-26
|
||||||
**Document Version**: 1.0
|
**Document Version**: 1.1
|
||||||
**Status**: Planning Phase
|
**Status**: Planning Phase
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue