jump / lara-api-starter

2.0.0-rc.1 2026-10-19 02:12 UTC

Requires

• php: ^8.2
• dedoc/scramble: ^0.13.10
• laravel/framework: ^12.41.1
• laravel/sanctum: ^4.0
• laravel/tinker: ^2.10.1
• scalar/laravel: ^0.2.1

Requires (Dev)

• fakerphp/faker: ^1.23
• larastan/larastan: ^3.0
• laravel/boost: ^2.0
• laravel/pail: ^1.2.2
• laravel/pint: ^1.24
• laravel/sail: ^1.41
• mockery/mockery: ^1.6
• nunomaduro/collision: ^8.6
• pestphp/pest: ^3.8
• pestphp/pest-plugin-laravel: ^3.2

MIT

• rest
• api
• laravel
• rbac
• starter
• sanctum

Published on Packagist.org on 2026-10-19 02:16 UTC

README

Laravel 12 API starter with Sanctum, Actions, typed DTOs, Resources, English/French translations and optional modules. Français.

composer create-project jump/lara-api-starter my-api
cd my-api
# The Composer hook starts the interactive installer.
# For a cloned checkout:
composer install
cp .env.example .env
php artisan api:install

For CI or unattended installation:

php artisan api:install --preset=minimal --database=sqlite --migrate --no-interaction
php artisan api:install --preset=standard --modules=webhooks --no-interaction
php artisan serve

Health: /api/v1/health. Scalar: /docs/api. Scramble specification: /docs/api.json; export with php artisan scramble:export. Documentation is accessible locally; elsewhere it is denied unless a nonempty DOCS_ACCESS_KEY is configured and presented in the docs_access_key cookie. Replace the gate with your organization's authentication policy when appropriate.

Preset	Modules
minimal	Core only
standard	rbac, two-factor, api-keys, preferences, notifications
full	All modules

Available modules: preferences, notifications, api-keys, media, export, import, webhooks, two-factor, social-login, rbac, impersonation, security-audit.

php artisan api:list
php artisan api:add webhooks
php artisan migrate
php artisan api:remove webhooks
php artisan api:doctor --database
php artisan make:api-scaffold Product
composer dev
composer check-all

Other generators: make:api-action, make:api-dto, make:api-request, make:api-resource, make:api-controller, make:api-stack.

The installer adds dependencies automatically and never removes existing modules when changing presets. Remove dependents before their dependencies. Removal refuses locally modified module files and retains database data and Composer packages. See UPGRADING.md.

Core AI guidelines and skills live in .ai/. Module instructions are installed and removed with the module. Run php artisan boost:install to select your AI agents; Boost generates their configuration. Subsequent module changes run boost:update when Boost has been configured.

See architecture, dependency decisions, and changelog.