Skip to content
WELD 0.1.2
Menu

Quick start#

This page takes a fresh copy of WELD from a folder to a running, checked app on your machine.

One command strikes the spark; the containers do the welding. Docker is the only prerequisite: PHP and Node run in the containers, so the host needs neither.

Steps#

  1. Bring the stack up:

    PowerShell

    .\bin\weld.ps1 up

    macOS / Linux

    bin/weld.sh up

    Expected: up copies .env.example to .env if it is missing, installs the PHP and Node dependencies in the containers, starts the app and Vite, generates the app key if it is not set, and runs the migrations.

  2. Open http://localhost:8000. Expected: the app, served by the local stack.

  3. Run the doctor:

    PowerShell

    .\bin\weld.ps1 doctor

    macOS / Linux

    bin/weld.sh doctor

    Expected: one line per check, PASS or WARN or FAIL; exit code 1 when anything FAILs. A good bead is a quiet one: all PASS and nothing to say.

  4. Run the checks:

    PowerShell

    .\bin\weld.ps1 test

    macOS / Linux

    bin/weld.sh test

    Expected: composer ci runs in the app container: validate, tests, Pint, PHPStan level 8, the agent-ready check and audit.

The subcommands#

The same subcommands work on every OS:

Command What it does
up Bring the whole stack up, as above
down Stop and remove the containers
test Run composer ci in the app container
doctor Run php artisan weld:doctor in the app container
logs Follow the container logs

What you built#

You have WELD running locally in Docker: the app and Vite in containers, .env copied from .env.example, the app key generated and the migrations run. That is the whole Wayne State app stack joined into one application, with sign-in, security headers, checks, coding standards, CI and the WayneUI interface already hooked up.

Next steps#

  • Make it yours: rename the four things that still say WELD (the composer name, the app name, the site title and the git remote), give the copy its own key, and re-run the checks.
  • Check your setup: what the doctor reports, joint by joint.
  • What is welded in: the parts and what each does in the app.
  • Running WELD off Citadel: for when the destination is somewhere other than a laptop.