33 lines
736 B
Markdown
33 lines
736 B
Markdown
# Optimal Project
|
|
|
|
A fully-configured Claude Code project demonstrating best practices.
|
|
|
|
## Overview
|
|
|
|
This project uses TypeScript with a standard src/tests layout. All configuration follows Claude Code best practices for permissions, hooks, rules, and tooling.
|
|
|
|
## Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `/build` | Build the project with status context |
|
|
|
|
## Architecture
|
|
|
|
```
|
|
src/ # Application source (TypeScript)
|
|
tests/ # Test files
|
|
.claude/ # Claude Code configuration
|
|
hooks/ # Git and Claude hooks
|
|
```
|
|
|
|
## Code Standards
|
|
|
|
- TypeScript strict mode
|
|
- ESLint + Prettier
|
|
- 80% test coverage minimum
|
|
|
|
## Gotchas
|
|
|
|
- Run `npm install` before first use
|
|
- Tests require Node.js 18+
|