README

This is a boilerplate that sets up a Laravel Project with Vue 3, InertiaJs, Tailwind CSS, Laravel Sail and Devcontainer.

It is designed to be used with the Laravel CLI tool.

Features

• Vue 3: Modern JavaScript framework for building user interfaces.
• Inertia.js: Allows you to create single-page apps using classic server-side routing
• Tailwind CSS: Utility-first CSS framework for rapid UI development.
• Laravel Sail: Provides a Docker development environment for Laravel applications.
• Devcontainer: Pre-configured development environment for Visual Studio Code.
• TypeScript: Static type checking for JavaScript, enhancing code quality and maintainability.
• Code Quality Tools: Includes Pint for PHP formatting and Husky for Git hooks.
• IDE Enhancements: Laravel IDE Helper for autocompletion and better developer experience.
• Debugging Tools: Laravel Debugbar for visualizing queries, routes, and performance metrics.
• Type Inertia Shared Data: Implements type-safe shared data for Inertia.js, ensuring better type safety and autocompletion in Vue components.
• Development Workflow: Composer scripts for common tasks to streamline development processes.

Getting Started

The easiest way to create a new project using this boilerplate is to use the Official Laravel CLI tool laravel/installer.

Method 1: Installing the Laravel CLI tool globally in your system

This method requires you to have the Laravel CLI tool installed globally on your system.

Requires:

• PHP
• Composer

To install the Laravel CLI tool globally, run the following command:

composer global require laravel/installer

Once you have the Laravel CLI tool installed, you can create a new project using the following command:

APP_NAME=new-app

laravel new $APP_NAME --using=rasmusgodske/laravel-sail-vue-starterkit

Method 2: Using Laravel Cli tool docker wrapper

If you prefer not to install the Laravel CLI tool globally, you can use the docker-laravel-cli which provides a Docker wrapper for the Laravel CLI tool. This allows you to run the Laravel CLI commands without installing it globally on your system.

APP_NAME=new-app

docker run -it --rm -v $(pwd):/workspace -e USER_ID=$(id -u) -e GROUP_ID=$(id -g) godske/docker-laravel-cli:latest laravel new $APP_NAME --using=rasmusgodske/laravel-sail-vue-starterkit

Starter Kit Documentation

For detailed documentation on how this specific starter kit is set up, please refer to the Setup Guide.