Skip to content

About

Production guides for Spring Boot services, proven by tested fixtures

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

23 Commits

Folders and files

Repository files navigation

Pyahu Initializer

Guides with the production practices Pyahu follows for Spring Boot, Java and Next.js, shared with the community. A generator that applies them comes later. Each step answers one question with the failure it prevents and every claim has a test behind it.

How a claim is proven

A fixture in fixtures/ is a real service built with the exact versions of a baseline in data/versions.yaml. CI builds it, runs the Go acceptance tests in acceptance/ against its image and writes an evidence report. Every claim a guide makes has a record in data/evidence/ with its test, run and commit. A claim nothing proves yet says why.

Layout

Path What
guides/ The Astro and Starlight site, its components and diagrams and the guide pages
services/start/, build-logic/, gradle/ The Initializer service behind start.pyahu.io (in development) and its Gradle build
frontends/start-web/ The page of start.pyahu.io: the form, the files it gives and the download (Next.js)
templates/ The files the service renders into a generated project
skills/ The guides as an Agent Skill, generated by guidekit generate
data/ Baselines, official documentation, checklist, evidence records, schemas
fixtures/ Services written by hand that prove the guides
acceptance/ Go behavioural tests run against the fixture images (build tag acceptance)
cmd/guidekit/, cmd/runworkflow/, internal/ Go tooling: checks, generated files, evidence, site and link checks, running a generated project's CI

Quick start

go run ./cmd/guidekit check            # data, guides, cross-references
cd guides && npm ci && npm run dev     # the site at http://localhost:4321 (Node 24.22.0)
./gradlew :start:bootRun               # the generator, in development
curl localhost:8080/starter.zip -d name=orders -o orders.zip
curl localhost:8080/starter.zip -d name=orders -d database=postgres -d auth=oidc -d frontend=nextjs -o orders.zip
cd frontends/start-web && npm ci && npm run dev   # the page at http://localhost:3001, against the generator

License

Code, data and fixtures: MIT (LICENSE). Guide text and diagrams: CC BY 4.0 (LICENSE-GUIDES.md). By Terson Rigaud, under the Pyahu community.

About

Production guides for Spring Boot services, proven by tested fixtures

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages