Skip to content

Commit 4b35178

Browse files
Claudehotlong
andauthored
Complete Claude Code migration documentation
Agent-Logs-Url: https://github.com/objectstack-ai/framework/sessions/4124267f-697a-403e-a4e3-81da8e87cea5 Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent ffa8f55 commit 4b35178

3 files changed

Lines changed: 846 additions & 0 deletions

File tree

.claudeignore

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Claude Code Ignore File
2+
# Files and directories that Claude Code should not analyze or modify
3+
4+
# Build outputs
5+
dist/
6+
build/
7+
.next/
8+
.turbo/
9+
out/
10+
11+
# Dependencies
12+
node_modules/
13+
.pnpm-store/
14+
15+
# Generated files
16+
*.generated.ts
17+
*.generated.js
18+
pnpm-lock.yaml
19+
package-lock.json
20+
yarn.lock
21+
22+
# Auto-generated documentation (do not edit manually)
23+
content/docs/references/
24+
25+
# Logs
26+
*.log
27+
logs/
28+
.DS_Store
29+
30+
# IDE and editor files (except .vscode settings we want to keep)
31+
.idea/
32+
*.swp
33+
*.swo
34+
*~
35+
36+
# Test coverage
37+
coverage/
38+
.nyc_output/
39+
40+
# Temporary files
41+
tmp/
42+
temp/
43+
*.tmp
44+
45+
# Environment files with secrets
46+
.env.local
47+
.env.*.local
48+
*.key
49+
*.pem
50+
*.cert
51+
52+
# Cache directories
53+
.cache/
54+
.parcel-cache/
55+
.eslintcache
56+
.stylelintcache
57+
58+
# OS files
59+
Thumbs.db
60+
.DS_Store
61+
62+
# Large binary files
63+
*.png
64+
*.jpg
65+
*.jpeg
66+
*.gif
67+
*.ico
68+
*.pdf
69+
*.zip
70+
*.tar.gz
71+
72+
# Vercel
73+
.vercel/
74+
75+
# Database files
76+
*.db
77+
*.sqlite
78+
*.sqlite3
79+
80+
# Backup files
81+
*.bak
82+
*.backup

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,49 @@ Key standards:
245245
- **camelCase** for configuration keys (e.g., `maxLength`, `defaultValue`)
246246
- **snake_case** for machine names / data values (e.g., `project_task`, `first_name`)
247247

248+
## AI-Assisted Development
249+
250+
### Claude Code Integration
251+
252+
This project is fully optimized for [Claude Code](https://claude.ai/claude-code) development:
253+
254+
- **[CLAUDE.md](./CLAUDE.md)** — Main AI instructions (auto-loaded by Claude Code)
255+
- **[docs/CLAUDE_CODE_GUIDE.md](./docs/CLAUDE_CODE_GUIDE.md)** — Complete development guide
256+
- **[.github/prompts/](. /.github/prompts/)** — Domain-specific prompts (Data, UI, System, AI, API)
257+
- **[skills/](./skills/)** — Detailed implementation guides for each domain
258+
259+
**Quick Start with Claude Code:**
260+
261+
```bash
262+
# 1. Clone and setup
263+
git clone https://github.com/objectstack-ai/framework.git
264+
cd framework
265+
pnpm install && pnpm build
266+
267+
# 2. Open in Claude Code
268+
# CLAUDE.md is automatically loaded
269+
270+
# 3. Ask Claude Code for help:
271+
# "Create a new field type for encrypted data"
272+
# "Add a new view type for timeline visualization"
273+
# "Implement a plugin for analytics"
274+
```
275+
276+
**Key Features:**
277+
- ✅ Comprehensive AI instruction system with 10+ domain-specific prompts
278+
- ✅ Auto-routing context based on file patterns
279+
- ✅ Zod-first development patterns enforced
280+
- ✅ Built-in best practices from Salesforce, ServiceNow, Kubernetes
281+
- ✅ 100+ code examples and patterns
282+
283+
See **[docs/CLAUDE_CODE_GUIDE.md](./docs/CLAUDE_CODE_GUIDE.md)** for complete documentation.
284+
285+
### GitHub Copilot Support
286+
287+
For GitHub Copilot users:
288+
- **[.github/copilot-instructions.md](./.github/copilot-instructions.md)** — Parallel to CLAUDE.md, kept in sync
289+
- All domain-specific prompts in `.github/prompts/` are automatically loaded
290+
248291
## Documentation
249292

250293
Full documentation: **[https://docs.objectstack.ai](https://docs.objectstack.ai)**

0 commit comments

Comments
 (0)