summaryrefslogtreecommitdiff
path: root/QUICKSTART.md
diff options
context:
space:
mode:
Diffstat (limited to 'QUICKSTART.md')
-rw-r--r--QUICKSTART.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/QUICKSTART.md b/QUICKSTART.md
new file mode 100644
index 0000000..f933506
--- /dev/null
+++ b/QUICKSTART.md
@@ -0,0 +1,48 @@
+# Doot Quickstart Guide
+
+This guide will help you get **Doot** up and running in under 5 minutes.
+
+## 1. Prerequisites
+- Go 1.24+
+- SQLite3
+- Node.js (for Tailwind build)
+
+## 2. Setup (3 Minutes)
+
+```bash
+# 1. Clone & Install
+git clone <repo_url> && cd doot
+go mod download
+npm install
+
+# 2. Configure Environment
+cp .env.example .env
+# Open .env and add your TRELLO_API_KEY, TRELLO_TOKEN, and TODOIST_API_KEY.
+
+# 3. Build & Run
+npm run build # Generates CSS
+go run cmd/dashboard/main.go
+```
+
+## 3. Configuration Reference
+
+| Variable | Description |
+|----------|-------------|
+| `TODOIST_API_KEY` | Your Todoist API Token |
+| `TRELLO_API_KEY` | Your Trello API Key |
+| `TRELLO_TOKEN` | Your Trello Token |
+| `DEFAULT_PASS` | Admin password for login |
+
+## 4. AI Agent Integration
+
+Doot provides a specialized API for AI agents to access your context safely.
+
+1. **Enable API:** Set `AI_AGENT_API_KEY` in your `.env`.
+2. **Access Context:** Use the internal endpoint `/agent/context` for a JSON snapshot of your day.
+3. **Browser Approval:** When an agent requests access, a notification will appear in your Doot dashboard for you to approve or deny.
+
+## 5. Maintenance Commands
+
+- **Run Tests:** `go test ./...`
+- **View Logs:** `./scripts/logs`
+- **Deploy:** `./scripts/deploy`