Skip to content

Commit c0e1d8b

Browse files
authored
docs README improvements
* docs: enhance README with detailed domain overview and feature descriptions * docs: update README for clarity and additional resources on Vertical Slice Architecture * docs: add GitHub stars badge to README for visibility
1 parent a4594fd commit c0e1d8b

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,13 @@ A learning template demonstrating **Vertical Slice Architecture** with a healthc
44

55
![.NET 9](https://img.shields.io/badge/.NET-9.0-512BD4)
66
![License](https://img.shields.io/badge/license-MIT-green)
7+
![GitHub stars](https://img.shields.io/github/stars/nadirbad/VerticalSliceArchitecture?style=social)
78

8-
> **New to Vertical Slice Architecture?** Read my blog post: [A Guide to Vertical Slice Architecture in C# .NET](https://nadirbad.dev/posts/vetical-slice-architecture-dotnet/)
9+
> **New to Vertical Slice Architecture?** Read my [Complete Guide to Vertical Slice Architecture](https://nadirbad.dev/vertical-slice-architecture-dotnet) or jump straight to the [Quick Start Guide](https://nadirbad.dev/vertical-slice-architecture-template-quickstart).
10+
11+
## Give it a Star ⭐
12+
13+
If you find this template useful, please give it a star! It helps others discover this project.
914

1015
## What is Vertical Slice Architecture?
1116

@@ -30,17 +35,19 @@ Traditional Layered: Vertical Slice:
3035
- Easier to understand, test, and maintain
3136
- Features can evolve independently
3237

33-
## Domain: Healthcare Appointments
38+
## Domain Overview
39+
40+
This template models a **medical clinic appointment scheduling system** where patients book appointments with doctors. The domain enforces real-world constraints: doctors cannot be double-booked, appointments must be scheduled in advance, and appointment lifecycle transitions are controlled (scheduled appointments can be completed or cancelled, but these are terminal states).
3441

35-
This template implements a **medical clinic scheduling system** - a realistic domain with meaningful business rules:
42+
### Features & Business Rules
3643

37-
| Feature | Endpoint | Business Rules |
38-
| -------------------- | ------------------------------------- | -------------------------------------------------------------------- |
39-
| **Book Appointment** | `POST /api/appointments` | No double-booking doctors, 15-min advance notice, 10min-8hr duration |
40-
| **Get Appointments** | `GET /api/appointments` | Filter by patient, doctor, status, date range |
41-
| **Get by ID** | `GET /api/appointments/{id}` | Returns full appointment details |
42-
| **Complete** | `POST /api/appointments/{id}/complete`| Cannot complete cancelled appointments |
43-
| **Cancel** | `POST /api/appointments/{id}/cancel` | Cannot cancel completed appointments, requires reason |
44+
| Feature | Endpoint | Key Business Rules |
45+
|---------|----------|-------------------|
46+
| **Book Appointment** | `POST /api/appointments` | No double-booking doctors, 15-min advance notice, 10min8hr duration |
47+
| **Get Appointments** | `GET /api/appointments` | Filter by patient, doctor, status, date range; paginated (max 100) |
48+
| **Get by ID** | `GET /api/appointments/{id}` | Returns full appointment with patient/doctor details |
49+
| **Complete** | `POST /api/appointments/{id}/complete` | Cannot complete cancelled appointments; idempotent |
50+
| **Cancel** | `POST /api/appointments/{id}/cancel` | Cannot cancel completed appointments; requires reason; idempotent |
4451

4552
## Quick Start
4653

@@ -242,13 +249,11 @@ dotnet test tests/Application.UnitTests
242249
dotnet test tests/Application.IntegrationTests
243250
```
244251

245-
## Give it a Star ⭐
246-
247-
If you find this template useful, please give it a star! It helps others discover this project.
248-
249252
## Learn More
250253

251-
- [My Blog Post on Vertical Slice Architecture](https://nadirbad.dev/posts/vetical-slice-architecture-dotnet/)
254+
- **[The Complete Guide to Vertical Slice Architecture](https://nadirbad.dev/vertical-slice-architecture-dotnet)** - Theory, principles, and implementation details
255+
- **[VSA vs Clean Architecture: Which Should You Choose?](https://nadirbad.dev/vertical-slice-vs-clean-architecture)** - Detailed comparison with migration strategies
256+
- **[Quick Start Guide](https://nadirbad.dev/vertical-slice-architecture-template-quickstart)** - Step-by-step setup instructions for this template
252257
- [Jimmy Bogard: Vertical Slice Architecture](https://jimmybogard.com/vertical-slice-architecture/)
253258
- [Derek Comartin: Organizing Code by Feature](https://codeopinion.com/organizing-code-by-feature-using-vertical-slices/)
254259

0 commit comments

Comments
 (0)