This VILT (Vue, Inertia.js, Laravel, Tailwind) stack boilerplate is a ready-to-go starting point for your next project.
It's actively used and maintained by Adam Campbell @hotmeteor.
Since this is a Laravel-based boilerplate you'll need a compatible environment.
See the Laravel installation docs for detailed instructions: https://laravel.com/docs/10.x/installation
This is a Laravel 10 app with:
- Jetstream, for Teams
- Vue + Inertia.js + Tailwind frontend
It also comes with the following tools and packages:
- Laravel Debugbar (barryvdh/laravel-debugbar): For local debugging (dev only)
- Laravel IDE Helper (barryvdh/laravel-ide-helper): For helping with accurate autocompletion in your IDE (dev only)
- Laravel Sitemap (spatie/laravel-sitemap): For automatically generating your sitemap once a day
- Pint (laravel/pint): For style fixing your PHP code
- Socialite (laravel/socialite): For providing SSO
- Telescope (laravel/telescope): For local debugging
- Prettier: For frontend code formatting
- prettier-plugin-organize-imports (simonhaenisch/prettier-plugin-organize-imports): For organizing imports in your Vue files
- prettier-plugin-tailwindcss (tailwindlabs/prettier-plugin-tailwindcss): For automatically sorting Tailwind classes based on Tailwind's recommended class order
Make sure your environment is configured as described in the Requirements section.
- In your terminal, go to your project folder
- Run
composer install - Run
npm install - Copy
.env.exampleto.envand configure as necessary (local URL, database connection, etc) - Run
php artisan key:generate
The development environment leverages Vite, as described in the Asset Bundling section of Laravel's docs.
To run the local server, simply run npm run dev
This boilerplate comes with a .github/workflows/tidy.yml file that will trigger Github Actions to format your PHP code using Pint whenever code is pushed to Github.
If you want to format your PHP code locally you can run composer tidy. This will both clean up your formattting and run the IDE helper scripts.
If you want to format your Vue or JS files locally you can run npm run prettier. This will clean up your formattting, plus reorganize imports and reorganize Tailwind classes.
- Adam Campbell created and manages this thing
- All of the people from the aforementioned packages, libraries, tools, etc. that did all the hard and important work
- All Contributors
Made with contributors-img.
The MIT License (MIT). Please see License File for more information.