Skip to content

Commit 673c7a6

Browse files
nanotaboadaCopilot
andcommitted
chore(docs): add Claude config and update README architecture diagram
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 7a29f0b commit 673c7a6

5 files changed

Lines changed: 28 additions & 189 deletions

File tree

.claude/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"model": "claude-sonnet-4-6"
3+
}

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# GitHub Copilot Instructions
1+
# Custom Instructions
22

33
## Overview
44

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.github/copilot-instructions.md

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nanotaboada_Dotnet.Samples.AspNetCore.WebApi&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=nanotaboada_Dotnet.Samples.AspNetCore.WebApi)
77
[![codecov](https://codecov.io/gh/nanotaboada/Dotnet.Samples.AspNetCore.WebApi/graph/badge.svg?token=hgJc1rStJ9)](https://codecov.io/gh/nanotaboada/Dotnet.Samples.AspNetCore.WebApi)
88
[![CodeFactor](https://www.codefactor.io/repository/github/nanotaboada/Dotnet.Samples.AspNetCore.WebApi/badge)](https://www.codefactor.io/repository/github/nanotaboada/Dotnet.Samples.AspNetCore.WebApi)
9-
[![License: MIT](https://img.shields.io/badge/License-MIT-white.svg)](https://opensource.org/licenses/MIT)
9+
[![License: MIT](https://img.shields.io/badge/License-MIT-3DA639.svg)](https://opensource.org/licenses/MIT)
10+
![GitHub Copilot](https://img.shields.io/badge/GitHub_Copilot-contributing-8662C5?logo=githubcopilot&logoColor=white&labelColor=181818)
11+
![Claude](https://img.shields.io/badge/Claude-Sonnet_4.6-D97757?logo=claude&logoColor=white&labelColor=181818)
12+
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/nanotaboada/Dotnet.Samples.AspNetCore.WebApi?utm_source=oss&utm_medium=github&utm_campaign=nanotaboada%2FDotnet.Samples.AspNetCore.WebApi&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews&labelColor=181818)
1013

1114
Proof of Concept for a RESTful API built with .NET 10 (LTS) and ASP.NET Core. Manage football player data with SQLite, Entity Framework Core, Swagger documentation, and in-memory caching.
1215

@@ -20,7 +23,7 @@ Proof of Concept for a RESTful API built with .NET 10 (LTS) and ASP.NET Core. Ma
2023
- [Prerequisites](#prerequisites)
2124
- [Quick Start](#quick-start)
2225
- [Testing](#testing)
23-
- [Docker](#docker)
26+
- [Containers](#containers)
2427
- [Releases](#releases)
2528
- [Environment Variables](#environment-variables)
2629
- [Command Summary](#command-summary)
@@ -33,7 +36,7 @@ Proof of Concept for a RESTful API built with .NET 10 (LTS) and ASP.NET Core. Ma
3336
- 📚 **Interactive API exploration** - Swagger UI documentation with health monitoring endpoints
3437
-**Performance optimizations** - In-memory caching, rate limiting, and efficient database queries
3538
- 🧪 **High test coverage** - xUnit tests with automated reporting to Codecov and SonarCloud
36-
- 📖 **Token-efficient documentation** - AGENTS.md + auto-loaded Copilot instructions for AI-assisted development
39+
- 📖 **Token-efficient documentation** - Custom instructions with coding guidelines, architecture rules, and agent workflows for AI-assisted development
3740
- 🐳 **Full containerization** - Multi-stage Docker builds with Docker Compose orchestration
3841
- 🔄 **Complete CI/CD pipeline** - Automated testing, code quality checks, Docker publishing, and GitHub releases
3942
- 🏟️ **Stadium-themed semantic versioning** - Memorable, alphabetical release names from World Cup venues
@@ -95,6 +98,7 @@ test/Dotnet.Samples.AspNetCore.WebApi.Tests/
9598
Dependencies flow from data layer through repositories and services to controllers. External dependencies (AutoMapper, FluentValidation, Serilog, Swashbuckle) integrate at their respective layers.
9699

97100
```mermaid
101+
98102
%%{init: {
99103
"theme": "default",
100104
"themeVariables": {
@@ -105,43 +109,39 @@ Dependencies flow from data layer through repositories and services to controlle
105109
"clusterBorder": "#ddd"
106110
}
107111
}}%%
108-
graph TB
109-
%% Layer 1: Data
110-
Data[Data]
111112
112-
%% Layer 2: Models
113-
Models[Models]
113+
graph RL
114114
115-
%% Layer 3: Repositories
116-
Repositories[Repositories]
115+
Models[Models]
117116
118-
%% Layer 4: Services
119117
subgraph Layer4[" "]
118+
Data[Data]
119+
Repositories[Repositories]
120+
end
121+
122+
subgraph Layer3[" "]
120123
Services[Services]
121124
Mappings[Mappings]
122125
AutoMapper[AutoMapper]
123126
MemoryCache[MemoryCache]
124127
end
125128
126-
%% Layer 5: Controllers
127-
subgraph Layer5[" "]
129+
subgraph Layer2[" "]
128130
Controllers[Controllers]
129131
Validators[Validators]
130132
FluentValidation[FluentValidation]
131133
Swashbuckle[Swashbuckle]
132134
end
133135
134-
%% Layer 6: Program
135-
subgraph Layer6[" "]
136+
subgraph Layer1[" "]
136137
Program[Program]
137138
Configurations[Configurations]
138139
Serilog[Serilog]
139140
end
140141
141-
%% Tests (separate)
142142
Tests[Tests]
143143
144-
%% Main Application Flow
144+
%% Application flow
145145
Data --> Models
146146
Models --> Repositories
147147
Repositories --> Services
@@ -164,8 +164,8 @@ graph TB
164164
MemoryCache --> Services
165165
166166
%% Tests connections
167-
Controllers -.-> Tests
168167
Services -.-> Tests
168+
Controllers -.-> Tests
169169
170170
%% Node styling with stroke-width
171171
classDef core fill:#b3d9ff,stroke:#6db1ff,stroke-width:2px,color:#555,font-family:monospace;
@@ -191,7 +191,7 @@ Interactive API documentation is available via Swagger UI at `https://localhost:
191191

192192
- `GET /players` - List all players
193193
- `GET /players/{id}` - Get player by ID (requires authentication)
194-
- `GET /players/squad/{squadNumber}` - Get player by squad number
194+
- `GET /players/{squadNumber}` - Get player by squad number
195195
- `POST /players` - Create new player
196196
- `PUT /players/{squadNumber}` - Update player
197197
- `DELETE /players/{squadNumber}` - Remove player
@@ -252,7 +252,7 @@ reportgenerator -reports:coverage/**/coverage.cobertura.xml -targetdir:coverage
252252

253253
Tests are located in the `test/` directory and use xUnit for unit testing. Coverage reports are generated for controllers and services only.
254254

255-
## Docker
255+
## Containers
256256

257257
This project includes full Docker support with multi-stage builds and Docker Compose for easy deployment.
258258

@@ -356,7 +356,7 @@ The application can be configured using environment variables for different scen
356356

357357
### Local Development (`.vscode/launch.json`)
358358

359-
For local debugging and development:
359+
For local development and debugging:
360360

361361
```bash
362362
# ASP.NET Core environment mode
@@ -372,9 +372,9 @@ ASPNETCORE_DETAILEDERRORS=1
372372
ASPNETCORE_SHUTDOWNTIMEOUTSECONDS=3
373373
```
374374

375-
### Docker Deployment (`compose.yaml`)
375+
### Container Deployment (`compose.yaml`)
376376

377-
For containerized production deployment:
377+
For production deployment:
378378

379379
```bash
380380
# Database storage path

scripts/count-tokens.sh

Lines changed: 0 additions & 165 deletions
This file was deleted.

0 commit comments

Comments
 (0)