weswecan / laravel-starter-kit
Starterkit for Laravel projects using inertia, typescript, sass, vue 3
Package info
github.com/WesWeCan/laravel-starter-kit
Type:project
pkg:composer/weswecan/laravel-starter-kit
Requires
- php: ^8.4
- fakerphp/faker: ^1.24.1
- inertiajs/inertia-laravel: ^3.7
- laravel/framework: ^13.40
- laravel/tinker: ^3.0.2
- tightenco/ziggy: ^2.6.5
Requires (Dev)
- laravel/boost: ^2.10.4
- laravel/dusk: ^8.7.2
- laravel/pail: ^1.2.7
- laravel/pao: ^1.1.5
- laravel/pint: ^1.32.1
- laravel/sail: ^1.69
- mockery/mockery: ^1.6.15
- nunomaduro/collision: ^8.9.5
- pestphp/pest: ^5.3.5
- pestphp/pest-plugin-laravel: ^5.0.1
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-06 11:41:19 UTC
README
This is a Laravel 13 starter configured for a Vue 3 + Inertia v3 app with TypeScript, Ziggy route helpers, axios, SCSS via Vite, and Laravel Dusk for E2E coverage.
Stack
- Backend: Laravel 13, Inertia Laravel adapter v3
- Frontend: Vue 3 with script setup and TypeScript
- Bundler: Vite 8 +
laravel-vite-plugin+@inertiajs/vite(page resolution; SSR disabled) - Fonts: Noto Sans, self-hosted at build time through
laravel-vite-plugin/fontsand@fonts - Dev tools:
vite-plugin-vue-devtools - Routing helpers: Ziggy (
@routesin Blade,ZiggyVuein Vue) - HTTP: Axios pre-configured in
bootstrap.ts - Styles: SCSS (global styles only; no styles inside SFCs)
- Icons:
@jamescoyle/vue-icon+@mdi/js - Testing: Pest + Laravel Dusk;
laravel/paoswitches test output to compact JSON when an AI agent runs the tests - AI tooling: Laravel Boost for Claude Code (
AGENTS.md,.mcp.json,.claude/skills) - DX: Laravel Pail (pretty app logs) and a queue worker wired in the dev script
Project layout (key files)
resources/js/app.ts: Inertia app bootstrap, imports../scss/index.scss, registersZiggyVue. Pages inresources/js/Pagesare resolved by the@inertiajs/viteplugin.resources/js/bootstrap.ts: axios onwindow, setsX-Requested-Withresources/js/Pages/*.vue: Inertia pages (TypeScript SFCs)resources/js/Components/<Domain>/*.vue: components, grouped by domain (e.g.Showcase/AllElements.vue)resources/js/Layouts/BasicLayout.vue: Base layout with<Head />resources/js/types/app.ts: shared page props;types/<domain>.tsfor each domainresources/scss/index.scss: global styles;baseline/(variables, palette, fonts, forms) andlayout/(band grid)resources/views/app.blade.php: Inertia root, includes@fonts,@routes+@viteapp/Http/Resources/<Domain>/*: JsonResources that shape what a page receivesvite.config.js: Laravel (with fonts) + Inertia + Vue + Vue DevTools pluginstsconfig.json: strict TS, path aliases (@/*,ziggy-js)
Conventions
- Vue SFCs: Always
script setup lang="ts"at the top, thentemplate. No<style>blocks in SFCs. - Styles: Put styles in
resources/scss/and@usethem from the area's index file. - Aliases: Use
@/forresources/js(configured intsconfig.json). - Routes: Use Ziggy's
route()in Vue (viaZiggyVue) and in Blade via@routes. - Page props: Pass them through a JsonResource and
->resolve()them; mirror the shape intypes/<domain>.ts. - Page titles: Set by Inertia using
VITE_APP_NAMEfor suffix.
Prerequisites
- PHP 8.4+
- Composer
- Node 22+ (Vite 8 and Sass need 20.19 or newer)
- Yarn 1 (pinned in
package.json;corepack enableprovides it)
Install
composer setup
This installs Composer and Yarn dependencies, creates .env, generates the app key, runs migrations, and builds the assets.
Develop
With Herd serving the site, you only need Vite:
yarn dev
To also run a local server, queue worker and Pail logs in one terminal:
composer run dev
Build
yarn build
Tests
composer test
Browser tests (Laravel Dusk)
Use Herd with the secured local domain from .env.dusk.local:
cp .env.dusk.local.example .env.dusk.local php artisan key:generate --env=dusk.local composer run dusk:detect-chromedriver yarn dev composer run dusk
- Default Dusk URL:
https://laravel-starter-kit.test - Default Dusk database:
laravel_testing - If Chrome updates locally, sync the driver again with
composer run dusk:detect-chromedriver.
Type checking
yarn vue-tsc --noEmit
Using Ziggy route helpers
- In Blade (already included):
@routes - In Vue (globally via
ZiggyVue):
route('index') route('posts.show', { post: 1 })
Refreshing the kit
Before starting a new project, ask Claude Code to refresh the starter kit. The refresh-starter-kit skill in .claude/skills/ updates the dependencies, regenerates Boost, compares the kit with the upstream Laravel skeleton, and audits it against the house rules.
Notes
- Axios is available as
window.axioswithX-Requested-Withset. - The Inertia progress bar uses
--text-color. assetsInclude: ['**/*.glsl']is enabled in Vite if you import GLSL assets.
What's included vs. not
- Included: Vue 3 + TS, Inertia v3, Ziggy, SCSS, self-hosted fonts, Axios, Vite, Vue DevTools, Pest, Dusk, Pail, Boost, queue worker in dev.
- Not included: SSR (switched off in
vite.config.jsandAppServiceProvider), authentication scaffolding, ESLint/Prettier config.