Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions .claudeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Claude Code Ignore File
# Files and directories that Claude Code should not analyze or modify

# Build outputs
dist/
build/
.next/
.turbo/
out/

# Dependencies
node_modules/
.pnpm-store/

# Generated files
*.generated.ts
*.generated.js
pnpm-lock.yaml
package-lock.json
yarn.lock

# Auto-generated documentation (do not edit manually)
content/docs/references/

# Logs
*.log
logs/
.DS_Store

# IDE and editor files (except .vscode settings we want to keep)
.idea/
*.swp
*.swo
*~

# Test coverage
coverage/
.nyc_output/

# Temporary files
tmp/
temp/
*.tmp

# Environment files with secrets
.env.local
.env.*.local
*.key
*.pem
*.cert

# Cache directories
.cache/
.parcel-cache/
.eslintcache
.stylelintcache

# OS files
Thumbs.db
.DS_Store

# Large binary files
*.png
*.jpg
*.jpeg
*.gif
*.ico
*.pdf
*.zip
*.tar.gz

# Vercel
.vercel/

# Database files
*.db
*.sqlite
*.sqlite3

# Backup files
*.bak
*.backup
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,49 @@ Key standards:
- **camelCase** for configuration keys (e.g., `maxLength`, `defaultValue`)
- **snake_case** for machine names / data values (e.g., `project_task`, `first_name`)

## AI-Assisted Development

### Claude Code Integration

This project is fully optimized for [Claude Code](https://claude.ai/claude-code) development:

- **[CLAUDE.md](./CLAUDE.md)** — Main AI instructions (auto-loaded by Claude Code)
- **[docs/CLAUDE_CODE_GUIDE.md](./docs/CLAUDE_CODE_GUIDE.md)** — Complete development guide
- **[.github/prompts/](. /.github/prompts/)** — Domain-specific prompts (Data, UI, System, AI, API)
- **[skills/](./skills/)** — Detailed implementation guides for each domain

**Quick Start with Claude Code:**

```bash
# 1. Clone and setup
git clone https://github.com/objectstack-ai/framework.git
cd framework
pnpm install && pnpm build

# 2. Open in Claude Code
# CLAUDE.md is automatically loaded

# 3. Ask Claude Code for help:
# "Create a new field type for encrypted data"
# "Add a new view type for timeline visualization"
# "Implement a plugin for analytics"
```

**Key Features:**
- ✅ Comprehensive AI instruction system with 10+ domain-specific prompts
- ✅ Auto-routing context based on file patterns
- ✅ Zod-first development patterns enforced
- ✅ Built-in best practices from Salesforce, ServiceNow, Kubernetes
- ✅ 100+ code examples and patterns

See **[docs/CLAUDE_CODE_GUIDE.md](./docs/CLAUDE_CODE_GUIDE.md)** for complete documentation.

### GitHub Copilot Support

For GitHub Copilot users:
- **[.github/copilot-instructions.md](./.github/copilot-instructions.md)** — Parallel to CLAUDE.md, kept in sync
- All domain-specific prompts in `.github/prompts/` are automatically loaded

## Documentation

Full documentation: **[https://docs.objectstack.ai](https://docs.objectstack.ai)**
Expand Down
Loading
Loading