summaryrefslogtreecommitdiff
path: root/QUICKSTART.md
diff options
context:
space:
mode:
authorPeter Stone <thepeterstone@gmail.com>2026-01-12 09:27:16 -1000
committerPeter Stone <thepeterstone@gmail.com>2026-01-12 09:27:16 -1000
commit9fe0998436488537a8a2e8ffeefb0c4424b41c60 (patch)
treece877f04e60a187c2bd0e481e80298ec5e7cdf80 /QUICKSTART.md
Initial commit: Personal Consolidation Dashboard (Phase 1 Complete)
Implemented a unified web dashboard aggregating tasks, notes, and meal planning: Core Features: - Trello integration (PRIMARY feature - boards, cards, lists) - Todoist integration (tasks and projects) - Obsidian integration (20 most recent notes) - PlanToEat integration (optional - 7-day meal planning) - Mobile-responsive web UI with auto-refresh (5 min) - SQLite caching with 5-minute TTL - AI agent endpoint with Bearer token authentication Technical Implementation: - Go 1.21+ backend with chi router - Interface-based API client design for testability - Parallel data fetching with goroutines - Graceful degradation (partial data on API failures) - .env file loading with godotenv - Comprehensive test coverage (9/9 tests passing) Bug Fixes: - Fixed .env file not being loaded at startup - Fixed nil pointer dereference with optional API clients (typed nil interface gotcha) Documentation: - START_HERE.md - Quick 5-minute setup guide - QUICKSTART.md - Fast track setup - SETUP_GUIDE.md - Detailed step-by-step instructions - PROJECT_SUMMARY.md - Complete project overview - CLAUDE.md - Guide for Claude Code instances - AI_AGENT_ACCESS.md - AI agent design document - AI_AGENT_SETUP.md - Claude.ai integration guide - TRELLO_AUTH_UPDATE.md - New Power-Up auth process Statistics: - Binary: 17MB - Code: 2,667 lines - Tests: 5 unit + 4 acceptance tests (all passing) - Dependencies: chi, sqlite3, godotenv Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Diffstat (limited to 'QUICKSTART.md')
-rw-r--r--QUICKSTART.md121
1 files changed, 121 insertions, 0 deletions
diff --git a/QUICKSTART.md b/QUICKSTART.md
new file mode 100644
index 0000000..e8dbf71
--- /dev/null
+++ b/QUICKSTART.md
@@ -0,0 +1,121 @@
+# Quick Start Guide
+
+## 5-Minute Setup
+
+### 1. Get API Keys
+
+#### Todoist (Required)
+1. Go to https://todoist.com/app/settings/integrations
+2. Scroll to "Developer" section
+3. Copy your **API token**
+
+#### Trello (Required)
+1. Go to https://trello.com/power-ups/admin
+2. Create a Power-Up (any name, e.g., "Personal Dashboard")
+3. Go to **API Key** tab
+4. Click **"Generate a new API Key"** and copy it (NOT the Secret!)
+5. In the API Key description, follow the "testing/for-yourself" instructions
+6. Click the **Token** link to generate a personal token
+7. Click **"Allow"** and copy the token
+
+**Important:** You need the API Key + Token (NOT the Secret). The Secret is for OAuth and not used for personal access.
+
+**That's it!** You now have everything you need.
+
+### 2. Configure
+
+```bash
+# Copy template
+cp .env.example .env
+
+# Edit .env and add:
+TODOIST_API_KEY=your_todoist_token
+TRELLO_API_KEY=your_trello_key
+TRELLO_TOKEN=your_trello_token
+```
+
+### 3. Run
+
+```bash
+go run cmd/dashboard/main.go
+```
+
+### 4. Access
+
+Open http://localhost:8080 in your browser!
+
+---
+
+## Optional: Add More Features
+
+### Obsidian Notes
+Add to `.env`:
+```bash
+OBSIDIAN_VAULT_PATH=/path/to/your/vault
+```
+
+### Claude.ai Access
+```bash
+# Generate key
+openssl rand -hex 32
+
+# Add to .env
+AI_AGENT_API_KEY=generated_key_here
+```
+
+Then share with Claude:
+- URL: `http://localhost:8080/api/claude/snapshot`
+- Token: (your AI_AGENT_API_KEY)
+
+---
+
+## What You'll See
+
+**Main Dashboard:**
+- 📋 **Trello Boards** at the top (your primary view)
+- ✓ **Todoist Tasks** below
+- 📝 **Recent Notes** (if Obsidian configured)
+- 🍽️ **Meal Plans** (if PlanToEat configured - optional)
+
+**Features:**
+- Auto-refresh every 5 minutes
+- Manual refresh button
+- Mobile-responsive design
+- Fast SQLite caching
+
+---
+
+## Troubleshooting
+
+### Can't start - missing API keys
+Make sure your `.env` has:
+```bash
+TODOIST_API_KEY=something
+TRELLO_API_KEY=something
+TRELLO_TOKEN=something
+```
+
+All three are required. Get them from:
+- Todoist: https://todoist.com/app/settings/integrations
+- Trello: https://trello.com/power-ups/admin (create Power-Up, generate both from API Key tab)
+
+### No boards showing
+- Check your Trello API key and token are correct
+- Make sure you have boards in your Trello account
+- Click the refresh button
+
+### No tasks showing
+- Verify Todoist API token is correct
+- Check you have active tasks in Todoist
+
+---
+
+## Next Steps
+
+1. ✅ Dashboard is running
+2. Check that data is loading
+3. Test the refresh button
+4. (Optional) Set up Claude.ai access
+5. Start using your unified dashboard!
+
+Need more details? See `SETUP_GUIDE.md` for comprehensive instructions.