blob: f933506b4a9fd09e9a2a7359d4bdabcd40f08656 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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`
|
