Skip to content
Menu

Quick start#

From a machine where sourdough is installed (see Install), bake an app and prove it.

Steps#

  1. Scaffold the app.

    sourdough new my-app
    

    Expected: exit code 0 (done). The my-app directory appears with a Wayne State app in it: SESAME (auth), HELMET (baseline runtime), PROCTOR (checks), and the Preflight CI components already wired in. Sourdough prints Next steps for the new app.

    Not sure which flags you want? The order counter on the front page writes the command for a shape, an oven and a name, with the same plan and Next steps this command prints. Its "Copy a link to this order" button gives you a link to send a coworker, and the link opens the counter on the same order.

  2. Run the app's own checks.

    From inside my-app/:

    composer ci
    

    Expected: exit code 0. A freshly baked app passes its own composer ci on the first run.

What you built#

  • A Wayne State app with the stack already wired in: SESAME (auth), HELMET (baseline runtime), PROCTOR (checks), and the Preflight CI components.
  • Playbook wiring by default: the VCS repository, the package in require, config.gitlab-domains so Composer sends your token to git.wayne.edu, the seven setting names in .env.example, a composer playbook script that shows whether Playbook is installed, and a "WSU values (PLAYBOOK)" README section.
  • ADVISOR in require-dev, a git-ignored .mcp.json, and an "ADVISOR" README section.
  • Squire's deploy kit, and a "Run it like Citadel" README subsection: the Parity commands that run the app on Citadel's own PHP image, proxy and MySQL 5.6.51. Parity is a separate install; parity init --from-squire reads the kit and writes parity.json, so Sourdough bakes none.
  • .sourdough/manifest.json, the starter's memory: the Sourdough version, the template, the answers you chose, and a sha256 hash of every file, each marked managed (Sourdough owns it and will update it) or seeded (Sourdough wrote it once and you own it now: .env.example, README.md, and package-lock.json on the shapes with a front end).
  • .sourdough/plan.yaml, the plan the app was baked from: the shape, the name and the stack parts (plus the models and pages, when you baked from a plan file). It bakes the same loaf again with --plan; see The saved plan.

Next steps#

  • Follow the app's printed Next steps: they point at composer playbook once dependencies are in, and at php vendor/bin/advisor install --client=claude --write for ADVISOR.
  • Pick a shape: the permutations, from raw PHP to Laravel plus Inertia/Vue.
  • Describe a plan: describe what the app does and let a model plan it.
  • The manifest: what the manifest records, and sourdough manifest --check.
  • CI: set up the generated app's CI; a git.wayne.edu instance runner is strongly recommended.
  • Commands: every flag and option.