Skip to content

Commit 507c680

Browse files
authored
Merge pull request #51 from bartstc/chore/update-README
chore: update README
2 parents e313667 + c00f736 commit 507c680

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,22 @@ An opinionated, production-ready starter for **Single Page Application** develop
3333

3434
### Architecture
3535

36-
- Feature slice architecture with clean architecture principles
36+
- Feature slice architecture with clean architecture principles — each feature has four layers (`components/`, `application/`, `providers/`, `models/`) with strict dependency rules
3737
- Centralized API layer with endpoint-based organization and type consolidation
38+
- Spec-driven development for AI-assisted workflows — four-phase gated spec process, typed building block patterns, and a self-improvement loop
3839
- Formatting utilities for numbers, monetary values, and dates
3940
- File naming: PascalCase for React components/stories/page objects, kebab-case for everything else
4041
- A demo app with authentication showcasing the project structure and tooling in action (powered by [Fake Store API](https://fakestoreapi.com/docs))
41-
- Read more about architecture: `docs/architecture.md`ś
42+
- Read more: [`docs/architecture.md`](docs/architecture.md)
43+
44+
### AI-assisted development
45+
46+
This project uses spec-driven development for non-trivial features. Instead of prompting an AI agent to "build X," you collaboratively write a short spec (80–150 lines) that constrains intent, design, and sequencing before any code is written.
47+
48+
- **Spec workflow** — four-phase gated process: Goal & Scope → Design → Sequencing → Review. Each phase requires developer approval before proceeding.
49+
- **Building blocks catalog** — typed patterns (mutations, queries, stores, components, hooks, models) that specs reference by name. The agent reads the pattern before implementing.
50+
- **Self-improvement loop** — lessons from past implementations accumulate in `specs/lessons.md` and feed back into future sessions.
51+
- Read more: [`docs/spec-development-docs.md`](docs/spec-development-docs.md)
4252

4353
## Getting started
4454

0 commit comments

Comments
 (0)