Skip to content

yaoyorozu-system/sample-template

Repository files navigation

Yaoyorozu System Sample Template

このリポジトリは、Yaoyorozu System のサンプル生成に使う Symfony アプリ雛形です。

アプリ固有のREQ、UI契約、実装、テンプレート、テストは含めません。yaoyorozu-system/core を取得したうえで、別途用意した docs/req/.yaoyorozu/req/ を入力として実装を進めるための出発点です。

位置づけ

公開物は次の3つに分けます。

リポジトリ 役割
yaoyorozu-system/core REQ検証、UI契約検証、階層化テスト、証跡、判定ゲートを提供する中核
yaoyorozu-system/sample-template 実装を持たない Symfony アプリ雛形
yaoyorozu-system/sample-artifact coresample-template から作成したサンプル成果物

このリポジトリは2つ目の雛形です。

含まれるもの

  • Symfony 8 の最小アプリ構成。
  • composer.json と Symfony 設定。
  • 空のREQ置き場: docs/req/
  • 空のUI契約置き場: .yaoyorozu/req/
  • 空の実装ディレクトリ: src/Application/, src/Controller/, src/Domain/, src/Infrastructure/, src/Presentation/
  • 空の画面テンプレート置き場: templates/
  • 空のテスト置き場: tests/cases/, tests/Support/

含まれないもの

  • アプリ固有のREQ本文。
  • REQごとのUI契約。
  • 画面、コントローラ、ドメインなどのアプリ実装。
  • 実装済みアプリのテストケース。
  • 生成済み証跡。

使い方

依存関係を取得します。

composer install

Yaoyorozu System の入口を確認します。

vendor/bin/yaorozu guide --ai

REQとUI契約を配置した後、次のように確認します。

vendor/bin/yaorozu list-reqs
vendor/bin/yaorozu check-req-integrity --json
vendor/bin/yaorozu verify-req REQ-APP-001
vendor/bin/yaorozu test-layers ALL
vendor/bin/yaorozu mihashira REQ-APP-001

ディレクトリ

パス 用途
docs/req/ REQ文書の正本を置く
.yaoyorozu/req/ REQごとのUI契約と証跡を置く
src/ アプリ実装を置く
templates/ Twigテンプレートを置く
tests/cases/ 階層化テストを置く
tests/Support/ テスト補助コードを置く

注意

このリポジトリ単体では完成アプリではありません。完成したサンプル成果物は yaoyorozu-system/sample-artifact として別に公開します。

About

Yaoyorozu System のサンプル生成に使う Symfony アプリ雛形。

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages