diff --git a/README.md b/README.md index 3b3f8ce..071edd6 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,79 @@ https://trackevery.day/ A simple, privacy-focused habit tracking web app. Track anything, every day. +## 🎯 Vision & Goal + +**Goal**: To provide the most frictionless, privacy-respecting tool for users to build consistency in their lives without the barrier of complex sign-ups or data tracking concerns. + +**Vision**: A world where self-improvement is accessible to everyone without trading their privacy for it. `trackevery-day` aims to become the standard for "unaccounted" personal tracking, eventually expanding into a broader minimalist "life logger" platform. + +## 💼 Business Model + +This project operates on a sustainable Open Source model: + +1. **Core Product (Free & Open Source)**: The full application is available for free. Users can self-host or use the public instance. +2. **Supporter Tier (Future)**: Optional premium features for power users who want to support development: + - Advanced Data Analysis & Trends + - Encrypted Cloud Backups + - API Access for integrations +3. **Donations**: Community support via GitHub Sponsors / Ko-fi to cover hosting costs. + +--- + +## 🗺️ Roadmap & Tasks + +We are building this out in phases. Below is the breakdown of problems into small, actionable tasks. + +### Phase 1: Core Refinement (Current Focus) + +_Goal: Polish the existing functionality to be feature-complete._ + +- [ ] **Habit Management** + - [ ] Add "Edit Habit" functionality (rename, change type/color). + - [ ] Add "Delete/Archive Habit" functionality (UI implementation). + - [ ] Implement "Undo Log" (remove accidental logs). +- [ ] **Visualization** + - [ ] Add a "Contribution Graph" (GitHub style) heatmap for each habit. + - [ ] Add a simple line chart for "Frequency over Time". +- [ ] **UX Improvements** + - [ ] specific mobile-responsive tweaks for the dashboard grid. + - [ ] Add a "Settings" page to manage the token (regenerate, view). + +### Phase 2: Data Sovereignty + +_Goal: Ensure users truly own their data._ + +- [ ] **Export/Import** + - [ ] Create JSON export handler. + - [ ] Create CSV export handler (for spreadsheet analysis). + - [ ] Build a "Restore from Backup" feature (JSON import). +- [ ] **Local-First Enhancements** + - [ ] Cache habit data in `localStorage` for faster load times. + - [ ] Implement offline queuing for logs when network is unavailable. + +### Phase 3: Engagement & Growth + +_Goal: Help users stay consistent._ + +- [ ] **PWA Implementation** + - [ ] Add `manifest.json` and service workers. + - [ ] Enable "Add to Home Screen" prompt. +- [ ] **Gamification (Subtle)** + - [ ] Visual rewards for hitting streaks (confetti, badges). + - [ ] "Levels" based on total consistency score. +- [ ] **Notifications** + - [ ] Browser-based push notifications for reminders (optional). + +### Phase 4: Advanced Features (Supporter Tier) + +_Goal: Power features for data nerds._ + +- [ ] **Public Profile** (Optional public shareable link for specific habits). +- [ ] **API Access** (Generate API keys to log via curl/scripts). +- [ ] **Webhooks** (Trigger events when a habit is logged). + +--- + ## ✨ Features - **Token-based authentication** - No email or password required