summaryrefslogtreecommitdiff
path: root/START_HERE.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 /START_HERE.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 'START_HERE.md')
-rw-r--r--START_HERE.md113
1 files changed, 113 insertions, 0 deletions
diff --git a/START_HERE.md b/START_HERE.md
new file mode 100644
index 0000000..ade3e98
--- /dev/null
+++ b/START_HERE.md
@@ -0,0 +1,113 @@
+# 👋 START HERE
+
+Welcome to your Personal Consolidation Dashboard!
+
+## First Time Setup (5 minutes)
+
+### Step 1: Get Your API Keys
+
+You need two things:
+
+1. **Todoist Token**
+ - Go to: https://todoist.com/app/settings/integrations
+ - Copy your API token
+
+2. **Trello Key + Token**
+ - Go to: https://trello.com/power-ups/admin
+ - Create a Power-Up (or select existing one)
+ - Go to **API Key** tab → Click **"Generate a new API Key"**
+ - Copy the **API Key** (NOT the Secret!)
+ - In the description below the API Key, find the "testing/for-yourself" instructions
+ - Click the **Token** link → Click **Allow** → Copy the token
+ - **Important:** You need API Key + Token, NOT the Secret
+
+### Step 2: Configure
+
+```bash
+# Copy the example file
+cp .env.example .env
+
+# Open .env in your editor and add:
+TODOIST_API_KEY=paste_your_todoist_token_here
+TRELLO_API_KEY=paste_your_trello_key_here
+TRELLO_TOKEN=paste_your_trello_token_here
+```
+
+### Step 3: Run
+
+```bash
+go run cmd/dashboard/main.go
+```
+
+### Step 4: Open Browser
+
+Go to: **http://localhost:8080**
+
+You should see:
+- ✅ Your Trello boards at the top
+- ✅ Your Todoist tasks below
+- ✅ Auto-refresh working
+
+**Done!** 🎉
+
+---
+
+## What Next?
+
+### Optional: Add Obsidian Notes
+If you use Obsidian, add to `.env`:
+```bash
+OBSIDIAN_VAULT_PATH=/path/to/your/vault
+```
+
+### Optional: Claude.ai Integration
+Want me (Claude) to access your dashboard?
+
+1. Generate a key:
+ ```bash
+ openssl rand -hex 32
+ ```
+
+2. Add to `.env`:
+ ```bash
+ AI_AGENT_API_KEY=paste_generated_key_here
+ ```
+
+3. Share with me:
+ - URL: `http://localhost:8080/api/claude/snapshot`
+ - Token: (your AI_AGENT_API_KEY)
+
+Then I can help you with "What's due today?" and more!
+
+---
+
+## Troubleshooting
+
+### Server won't start
+**Error:** "TODOIST_API_KEY is required"
+
+**Fix:** Make sure `.env` has all three:
+```bash
+TODOIST_API_KEY=...
+TRELLO_API_KEY=...
+TRELLO_TOKEN=...
+```
+
+### No Trello boards showing
+**Fix:** Check you got **both** from https://trello.com/power-ups/admin:
+1. API Key (from Power-Up's "API Key" tab)
+2. Token (click "Token" link next to API key)
+
+### Need more help?
+See **[QUICKSTART.md](QUICKSTART.md)** for more details.
+
+---
+
+## Next Steps
+
+- ✅ **Dashboard is running!**
+- 📖 Read [PROJECT_SUMMARY.md](PROJECT_SUMMARY.md) for overview
+- 🔧 See [SETUP_GUIDE.md](SETUP_GUIDE.md) for advanced setup
+- 🤖 Check [AI_AGENT_SETUP.md](AI_AGENT_SETUP.md) for Claude integration
+
+**Happy organizing!** 🚀