From dcfdb032128f6991e2323c67e4c4c0da0b18e15f Mon Sep 17 00:00:00 2001 From: Imani Manyara Date: Sun, 4 Oct 2026 07:12:38 -0400 Subject: [PATCH] Add a Quick start guide and usage section The README standard now splits the section into Getting started, the setup a fresh install needs before the first call, and Usage. Every command, tag and env key shown was checked against the package's own provider, config or CLI. --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 6eff51c..7962107 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,36 @@ upstream sibling repo: 4. Read `docs/api/v1.yaml` (OpenAPI 3.1 spec) for the contract surface; controllers conform to it. +## Quick start guide and usage + +### Getting started + +On a checkout where the Laravel skeleton has landed, one Composer +script does the first-run setup: it installs PHP dependencies, +copies `.env.example` to `.env`, generates the app key, runs the +migrations, then installs and builds the frontend. + +```bash +composer run setup +``` + +### Usage + +Run the app server, queue worker, log tail and Vite together: + +```bash +composer run dev +``` + +Run the test suite: + +```bash +composer test +``` + +The remaining bootstrap steps (Passport, Inertia + React, +multi-tenancy) are in [`INITIALIZE.md`](INITIALIZE.md). + ## Status | | |