README

Starter scaffolding package for Laravel websites. It generates routes, controllers, Blade components, and optional modules for SEO, blog, and careers.

Requirements

• PHP 8.2+
• Laravel 12 (Illuminate Support ^12.0)

Installation

composer require artworksit/starter --dev

This package is intended for scaffolding during development and does not need to be installed in production.

Usage

php artisan starter:install

The installer asks which static pages to create and optionally adds SEO, blog, and careers modules.

SEO scaffolding

When SEO is installed, Starter now scaffolds a class-based SEO component and reusable concerns:

• App\View\Components\Seo prepares SEO data for rendering
• resources/views/components/seo.blade.php remains presentational
• App\Models\Concerns\HasSeoMorph centralizes model SEO URL sync logic
• App\Filament\Resources\Concerns\HasSeoFormFields centralizes SEO form fields
• App\Filament\Resources\Concerns\HandlesSeoFormData centralizes SEO page data handling

SEO tags are rendered through <x-seo /> as the single source of truth.

Options

• --force overwrite files generated by Starter
• --dry-run show what would be generated without writing files
• --install-deps install required dependencies for optional modules

Typography Tokens

php artisan starter:typography:build

This command generates typography tokens from a CSV file. Use the --csv option to provide a custom path or --scale to adjust the 3xl scaling behavior.

OG Images

php artisan starter:og-generate

This command generates OG images in batch mode from a CSV file. If the CSV does not exist, it will be created from the Starter manifest.

CSV format

slug,header,subtext,input,output
home,Home,,public/assets/og/default.png,public/og

• slug becomes the output filename: {output}/{slug}.png
• input is the source image; if missing, public/assets/og/default.png is used (auto-copied from the package default if needed)
• output is a folder path

Options

• --csv path to the CSV (default resources/og.csv)
• --force overwrite existing images
• --strict fail on invalid rows or missing fonts
• --heading-* and --subtext-* override font settings (size, color, position, alignment)

Sitemap

php artisan starter:sitemap:generate

This command generates an application command stub at app/Console/Commands/GenerateSitemapCommand.php.

Then run:

php artisan sitemap:generate

The generated command creates sitemap.xml by browsing application routes. It asks for your domain and defaults to APP_URL.

Route handling

• Home route / uses priority 1.0
• Static routes use priority 0.8
• Slug routes use priority 0.6
• Other dynamic placeholder routes use priority 0.4
• Filament routes are excluded

Options

• starter:sitemap:generate --force overwrite existing generated command stub
• sitemap:generate --domain domain used in generated URLs (if omitted, command prompts with default from APP_URL)
• sitemap:generate --output output file path (default public/sitemap.xml)
• sitemap:generate --force overwrite existing sitemap file

Configuration

Publish the config file to customize package settings.

php artisan vendor:publish --tag=starter-config

Config path: config/starter.php.

License

MIT. See LICENSE.