Skip to content
Menu

Pick a shape#

A starter in a jar is only potential until you give it a shape: pick the permutation below, then run sourdough new with the matching flags. If you would rather describe the app in a sentence and let a model plan it, continue to Describe a plan.

Five loaves on the proofing bench (raw, raw + vue, blade, blade + islands, inertia) above the feeding schedule chalkboard

The five permutations#

Flags Permutation
(none) or --raw Raw PHP with WayneUI's standalone path
--raw --vue Raw PHP + Vue SPA over JSON
--laravel Laravel + Blade
--laravel --vue Laravel + Blade + Vue islands
--laravel --inertia (or --inertia) Laravel + Inertia/Vue

All five permutations bake: raw PHP since 0.1.0, the three Laravel shapes since 0.1.5 and raw PHP + Vue since 0.1.6. --raw --vue is the raw PHP bake with a Vue 3 front end over it: PHP answers JSON under /api/, Vite builds the Vue app, and src/Vite.php loads it from the build or the dev server.

Run sourdough new with the flags for the row you want. dir is the directory to create the app in. The CLI is one PHP command, so each line below runs the same in Windows PowerShell as in sh; Windows needs no bash or WSL:

raw

sourdough new my-app --raw

raw + vue

sourdough new my-app --raw --vue

laravel

sourdough new my-app --laravel

laravel + vue

sourdough new my-app --laravel --vue

inertia

sourdough new my-app --inertia

The template directories#

Each shape bakes from a directory in templates/:

Template directory Shape
raw/ Raw PHP with WayneUI's standalone path
raw-vue/ Raw PHP + Vue SPA over JSON (copied over raw/)
laravel-blade/ Laravel + Blade
laravel-blade-vue/ Laravel + Blade + Vue islands
laravel-inertia/ Laravel + Inertia/Vue

squire/ holds Squire's exported deploy files. Squire owns them; Sourdough installs them as-is into every app and records them in the manifest, so you never edit them by hand.

The raw template also carries its own checks:

  • Pinstripe's coding standard: pint.json (the per preset, with the fetched public/wayne-ui.php kept out and vendor excluded) and phpstan.neon (Pinstripe's raw preset, level 8 over src/ and public/), with waynestate/pinstripe in require-dev and the extension-installer plugin allowed, and lint, fix and analyse scripts, so composer ci runs test, lint, analyse, proctor and audit in that order.
  • An explicit composer-ci job in .gitlab-ci.yml (composer install, then composer ci), mirroring the Laravel overlay, so PROCTOR sees a composer ci in the pipeline instead of warning that no job runs it.
  • stubs/wayne-ui.php, a static-analysis stub for the run-time WayneUI functions (wsu_shell_start, wsu_shell_end) that phpstan.neon scans through scanFiles.
  • A front controller that answers 404 for any path but / (a short not-found page that keeps WayneUI's layout and links home) instead of rendering the home page for every URL; /up stays HELMET's and answers first.

Raw PHP + Vue#

--raw --vue keeps everything above and swaps the page for a Vue 3 app. PHP boots HELMET, the session and SESAME the same way, then answers JSON under /api/ (/api/me is the signed-in user) and sends one page that loads the Vue app. WayneUI comes from its Vue package and its layered dist stylesheet, pinned as in the Inertia shape, so there is no public/wayne-ui.php to fetch. Run it with:

composer install
npm install
npm run build
composer serve

Run npm run dev in a second terminal for hot reload: src/Vite.php loads the app from the dev server while it runs, and from public/build otherwise. See Templates for every file it adds.

Oracle in every shape#

Oracle is wired but dormant in every generated app. The settings ORACLE_USERNAME, ORACLE_PASSWORD, and either ORACLE_TNS or ORACLE_HOST, ORACLE_PORT, ORACLE_SERVICE_NAME ship commented out in .env.example; while they are empty, nothing connects and nothing errors. Once you fill them in, Laravel apps check the wiring with php artisan oracle:check, and raw PHP apps run queries through the App\Oracle helper, which takes values only as binds and answers mistakes with plain sentences. The command finds the check file where it lives: oracle-check.php at the app root, where Squire's Laravel layout ships it, first, then deploy/oracle-check.php.