Skip to content

Commit 7e19777

Browse files
PAMulliganPaul Mulliganclaude
authored
docs: add Aurelius-to-Nerva full-stack workflow guide (#23) (#127)
Add docs/schema-to-api/aurelius-pipeline.md, the dedicated walkthrough for /build-from-aurelius that the docs referenced but never provided. It carries one storefront example end to end: - how Aurelius produces build-spec.json and what Nerva reads from it, distinguished from Nerva's own .claude/plans/build-spec.json - the Phase 1 analysis that infers models, auth, and pagination - the generated OpenAPI 3.1 spec - the Phase 3 component-to-endpoint mapping and user confirmation - the handoff to /build-from-schema - the typed client from ./scripts/generate-client.sh and how the frontend imports it - an ASCII Aurelius <-> Nerva data-flow diagram, plus frontend-only data handling and a troubleshooting table Linked from the main README (From Aurelius section and the Documentation table) and from docs/schema-to-api/README.md. Co-authored-by: Paul Mulligan <paul@pmds.pull-list.net> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent dd56ad7 commit 7e19777

3 files changed

Lines changed: 409 additions & 0 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,8 @@ Structured interview (7-10 questions) that generates an OpenAPI spec, then feeds
8686

8787
Takes an [Aurelius](https://github.com/PMDevSolutions/Aurelius) frontend `build-spec.json` and generates the matching backend API. This enables a full-stack workflow: design in Figma, build frontend with Aurelius, generate backend with Nerva, share a typed API client.
8888

89+
See the [Aurelius → Nerva walkthrough](docs/schema-to-api/aurelius-pipeline.md) for a worked example: a frontend `build-spec.json`, the OpenAPI spec it generates, the component-to-endpoint mapping, and the typed client that bridges both sides.
90+
8991
## Directory Structure
9092

9193
```
@@ -205,6 +207,7 @@ Nerva is the backend counterpart in a family of Claude Code-integrated developme
205207
| Architecture | [`docs/onboarding/architecture.md`](docs/onboarding/architecture.md) | System architecture overview |
206208
| Troubleshooting | [`docs/onboarding/troubleshooting.md`](docs/onboarding/troubleshooting.md) | Common issues and solutions |
207209
| Pipeline guide | [`docs/schema-to-api/README.md`](docs/schema-to-api/README.md) | 10-phase pipeline deep dive |
210+
| Aurelius pipeline | [`docs/schema-to-api/aurelius-pipeline.md`](docs/schema-to-api/aurelius-pipeline.md) | Generate a backend from an Aurelius frontend build-spec |
208211
| API standards | [`docs/api-development/README.md`](docs/api-development/README.md) | TypeScript, Hono, testing conventions |
209212
| Agent catalog | [`.claude/CUSTOM-AGENTS-GUIDE.md`](.claude/CUSTOM-AGENTS-GUIDE.md) | All 24 agents with use cases |
210213
| Plugin reference | [`.claude/PLUGINS-REFERENCE.md`](.claude/PLUGINS-REFERENCE.md) | Plugin configuration and commands |

docs/schema-to-api/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Convert an OpenAPI specification into a fully working, tested API server through an automated 10-phase pipeline.
44

5+
## Where the Spec Comes From
6+
7+
The pipeline below starts from an OpenAPI specification. Write that spec by hand, or generate it:
8+
9+
- **From an Aurelius frontend** -- [`/build-from-aurelius`](./aurelius-pipeline.md) reads a frontend `build-spec.json`, infers the API it needs, generates the OpenAPI spec, and feeds it into the phases below. See the [Aurelius → Nerva walkthrough](./aurelius-pipeline.md).
10+
- **From a conversation** -- `/build-from-conversation` generates the spec through a structured interview.
11+
12+
Both converge on the same 10 phases.
13+
514
## Pipeline Overview
615

716
| Phase | Name | Description |

0 commit comments

Comments
 (0)