Skip to content

Commit fe0fe59

Browse files
committed
Update README.md
1 parent 19c7bd4 commit fe0fe59

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ Durable job processing with ServiceStack's Background Jobs:
9292
- **Email Queue** - SMTP email sending via background jobs
9393
- **Recurring Jobs** - Scheduled task execution
9494
- **Job Dashboard** - Monitor jobs at `/admin-ui/jobs`
95+
- Uses monthly rolling Sqlite databases by default - [Upgrade to PostgreSQL/SQL Server/MySQL](#upgrading-to-enterprise-database)
9596

9697
### 🤖 AI Chat Integration
9798

@@ -258,6 +259,7 @@ npm run test:ui # Run tests with UI
258259
npm run test:run # Run tests once
259260
```
260261

262+
261263
## Configuration
262264

263265
### Key Configuration Files
@@ -455,6 +457,46 @@ These are inferred from the GitHub Action context and don't need to be configure
455457
- **GitHub Container Registry** integration
456458
- **Volume persistence** for App_Data including any SQLite database
457459

460+
## AI-Assisted Development with CLAUDE.md
461+
462+
As part of our objectives of improving developer experience and embracing modern AI-assisted development workflows - all new .NET SPA templates include a comprehensive `AGENTS.md` file designed to optimize AI-assisted development workflows.
463+
464+
### What is CLAUDE.md?
465+
466+
`CLAUDE.md` and [AGENTS.md](https://agents.md) onboards Claude (and other AI assistants) to your codebase by using a structured documentation file that provides it with complete context about your project's architecture, conventions, and technology choices. This enables more accurate code generation, better suggestions, and faster problem-solving.
467+
468+
### What's Included
469+
470+
Each template's `AGENTS.md` contains:
471+
472+
- **Project Architecture Overview** - Technology stack, design patterns, and key architectural decisions
473+
- **Project Structure** - Gives Claude a map of the codebase
474+
- **ServiceStack Conventions** - DTO patterns, Service implementation, AutoQuery, Authentication, and Validation
475+
- **API Integration** - TypeScript DTO generation, API client usage, component patterns, and form handling
476+
- **Database Patterns** - OrmLite setup, migrations, and data access patterns
477+
- **Common Development Tasks** - Step-by-step guides for adding APIs, implementing features, and extending functionality
478+
- **Testing & Deployment** - Test patterns and deployment workflows
479+
480+
### Extending with Project-Specific Details
481+
482+
The existing `CLAUDE.md` serves as a solid foundation, but for best results, you should extend it with project-specific details like the purpose of the project, key parts and features of the project and any unique conventions you've adopted.
483+
484+
### Benefits
485+
486+
- **Faster Onboarding** - New developers (and AI assistants) understand project conventions immediately
487+
- **Consistent Code Generation** - AI tools generate code following your project's patterns
488+
- **Better Context** - AI assistants can reference specific ServiceStack patterns and conventions
489+
- **Reduced Errors** - Clear documentation of framework-specific conventions
490+
- **Living Documentation** - Keep it updated as your project evolves
491+
492+
### How to Use
493+
494+
Claude Code and most AI Assistants already support automatically referencing `CLAUDE.md` and `AGENTS.md` files, for others you can just include it in your prompt context when asking for help, e.g:
495+
496+
> Using my project's AGENTS.md, can you help me add a new AutoQuery API for managing Products?
497+
498+
The AI will understand your App's ServiceStack conventions, React setup, and project structure, providing more accurate and contextual assistance.
499+
458500
## Ideal Use Cases
459501

460502
- SaaS applications requiring authentication

0 commit comments

Comments
 (0)