Skip to content

feat: getting-started steps for new api-platform CLI installer - #675

Merged
soyuka merged 1 commit into
stagingfrom
feat/installer-getting-started
Jun 12, 2026
Merged

feat: getting-started steps for new api-platform CLI installer#675
soyuka merged 1 commit into
stagingfrom
feat/installer-getting-started

Conversation

@soyuka

@soyuka soyuka commented Jun 11, 2026

Copy link
Copy Markdown
Member

What

Updates the homepage Getting Started timeline to use the new api-platform CLI installer (api-platform/api-platform#2980), replacing the old gh repo create --template distribution flow.

Changes

  • Symfony (?s=symfony): curl -fsSL https://api-platform.com/install.sh | sh then api-platform my-api --framework=symfony --with-docker --with-pwa; added a PWA frontend block (cd ../pwa && pnpm dev).
  • Laravel (?s=laravel): scaffold with api-platform my-app --framework=laravel --with-admin; restructured into Scaffold a project / Run the app steps. Kept a note pointing existing-project users to composer require api-platform/laravel.
  • PHP (default): kept composer require api-platform/core (the documented framework-agnostic entry — granular components have no getting-started docs path); added a pointer to the CLI for scaffolding full Symfony/Laravel apps.

Depends on

Until both ship the one-liner 404s, so land this last.

Verify

cd pwa && pnpm install && pnpm dev, then check /?s=symfony, /?s=laravel, and / (PHP) render the new commands and copy buttons work; pnpm build passes.

Replace the gh repo create distribution flow with the new
`api-platform` CLI (api-platform/api-platform#2980) on the homepage
Getting Started timeline.

- Symfony: curl install.sh | sh + api-platform --framework=symfony
  --with-docker --with-pwa; add PWA frontend block.
- Laravel: scaffold via --framework=laravel --with-admin, restructured
  into Scaffold / Run steps; keep composer require note for existing apps.
- PHP: keep composer require api-platform/core, add pointer to the CLI
  for full Symfony/Laravel apps.

Depends on the install.sh script (#674) and a published api-platform
CLI release.
@soyuka
soyuka merged commit 25af53c into staging Jun 12, 2026
@soyuka
soyuka deleted the feat/installer-getting-started branch June 12, 2026 05:58
pull Bot pushed a commit to alexisLefebvre/api-platform-website that referenced this pull request Jun 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant