weswecan/laravel-starter-kit

Starterkit for Laravel projects using inertia, typescript, sass, vue 3

Maintainers

Package info

github.com/WesWeCan/laravel-starter-kit

Type:project

pkg:composer/weswecan/laravel-starter-kit

Statistics

Installs: 17

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

dev-main 2026-03-15 08:16 UTC

Requires

Requires (Dev)

MIT 185c037e90af7956817ed6e64a44cd54f6df9815

frameworklaravel

This package is auto-updated.

Last update: 2026-03-15 08:16:12 UTC

README

This is a Laravel 12 starter configured for a Vue 3 + Inertia app with TypeScript, Ziggy route helpers, axios, SCSS via Vite, and Laravel Dusk for E2E coverage.

Stack

  • Backend: Laravel 12, Inertia Laravel adapter
  • Frontend: Vue 3 with script setup and TypeScript
  • Bundler: Vite 8 + laravel-vite-plugin
  • Dev tools: vite-plugin-vue-devtools
  • Routing helpers: Ziggy (@routes in Blade, ZiggyVue in Vue)
  • HTTP: Axios pre-configured in bootstrap.ts
  • Styles: SCSS (global styles only; no styles inside SFCs)
  • Testing: Pest + Laravel Dusk
  • DX: Laravel Pail (pretty app logs) and a queue worker wired in the dev script

Project layout (key files)

  • resources/js/app.ts: Inertia + Vue app bootstrap, imports ../scss/index.scss, registers ZiggyVue
  • resources/js/bootstrap.ts: axios on window, sets X-Requested-With
  • resources/js/Pages/*.vue: Inertia pages (TypeScript SFCs)
  • resources/js/Layouts/BasicLayout.vue: Base layout with <Head />
  • resources/scss/index.scss: global styles (uses _variables.scss)
  • resources/views/app.blade.php: Inertia root, includes @routes + @vite
  • vite.config.js: Laravel + Vue + Vue DevTools plugins
  • tsconfig.json: strict TS, path aliases (@/*, ziggy-js)

Conventions

  • Vue SFCs: Always script setup lang="ts" at the top, then template. No <style> blocks in SFCs.
  • Styles: Put styles in resources/scss/ and import from app.ts.
  • Aliases: Use @/ for resources/js (configured in tsconfig.json).
  • Routes: Use Ziggy's route() in Vue (via ZiggyVue) and in Blade via @routes.
  • Page titles: Set by Inertia using VITE_APP_NAME for suffix.

Prerequisites

  • PHP 8.3+
  • Composer
  • Node 18+
  • Yarn

Install

composer install
cp .env.example .env
php artisan key:generate
yarn install

Develop

Run backend and frontend in two terminals:

php artisan serve
yarn dev

If you use Valet, you can skip php artisan serve and just run yarn dev.

Alternatively, a single command exists via Composer (spawns server, queue worker, pail logs, and Vite).

composer run dev

Build

yarn build

Tests

composer test

Browser tests (Laravel Dusk)

Use Valet with the secured local domain from .env.dusk.local:

cp .env.dusk.local.example .env.dusk.local
php artisan key:generate --env=dusk.local
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 with:
composer run dusk:detect-chromedriver

Type checking

  • Vue SFC-aware type-check:
yarn dlx vue-tsc --noEmit
  • Or plain TS (non-SFC):
yarn tsc --noEmit

Using Ziggy route helpers

  • In Blade (already included): @routes
  • In Vue (globally via ZiggyVue):
route('index')
route('posts.show', { post: 1 })

Notes

  • Axios is available as window.axios with X-Requested-With set.
  • The Inertia progress bar is enabled with a gray color.
  • assetsInclude: ['**/*.glsl'] is enabled in Vite if you import GLSL assets.

What’s included vs. not

  • Included: Vue 3 + TS, Inertia, Ziggy, SCSS, Axios, Vite, Vue DevTools, Pest, Pail, queue worker in dev.
  • Not included: SSR, authentication scaffolding, ESLint/Prettier config.