Skip to content

Commit a53f228

Browse files
committed
feat: add AI Agents.md (alternative to #1814)
1 parent 10c7b25 commit a53f228

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

.github/AGENTS.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# AI Agent Instructions
2+
3+
This document provides a quick reference for AI agents working on the Kleinkram project. For detailed information, always refer to the official documentation in the `../docs/` directory.
4+
5+
## 🚀 Quick Start (Launch)
6+
7+
To launch the full application stack:
8+
9+
```bash
10+
docker compose up -d
11+
```
12+
13+
**Access Points:**
14+
15+
- **API Server**: [http://localhost:3000](http://localhost:3000)
16+
- **Frontend**: [http://localhost:8003](http://localhost:8003)
17+
- **MinIO Console**: [http://localhost:9001](http://localhost:9001)
18+
- **Documentation**: [http://localhost:4000](http://localhost:4000)
19+
20+
> [!NOTE]
21+
> See [../docs/development/getting-started.md](../docs/development/getting-started.md) for detailed setup instructions.
22+
23+
## 🛠️ Development Workflow
24+
25+
### API Interaction
26+
27+
**IMPORTANT**: All API calls to the backend must include the `kleinkram-client-version` header matching the current app version (e.g., `0.56.0`).
28+
29+
```typescript
30+
headers: {
31+
'kleinkram-client-version': '0.56.0', // Replace with actual version from package.json
32+
...
33+
}
34+
```
35+
36+
### Formatting & Linting
37+
38+
Run these commands before submitting changes:
39+
40+
```bash
41+
# Format Python code
42+
black .
43+
44+
# Format TypeScript/JavaScript/JSON/Markdown
45+
yarn run prettier
46+
47+
# Run Linting
48+
yarn run eslint-full:quiet
49+
```
50+
51+
### Testing
52+
53+
**Backend Tests:**
54+
55+
```bash
56+
# Run all tests
57+
yarn test
58+
59+
# Run specific test file
60+
npx jest tests/actions/action-file-events.test.ts --runInBand --detectOpenHandles --forceExit
61+
```
62+
63+
**CLI/Python Tests:**
64+
65+
```bash
66+
# Run pytest (ensure virtualenv is active)
67+
pytest
68+
```
69+
70+
> [!NOTE]
71+
> See [../docs/development/testing/getting-started.md](../docs/development/testing/getting-started.md) for detailed testing guide.
72+
73+
## 📚 Documentation Reference
74+
75+
- **General Setup**: [../docs/development/getting-started.md](../docs/development/getting-started.md)
76+
- **Testing**: [../docs/development/testing/getting-started.md](../docs/development/testing/getting-started.md)
77+
- **Python/CLI**: [../docs/development/python/getting-started.md](../docs/development/python/getting-started.md)

0 commit comments

Comments
 (0)