Personal Laravel Development Environment

This repository contains my personal default Laravel development environment, based on a laravel new installation and Laravel Breeze for setting up Inertia.js, Vue.js, TypeScript, and Tailwind CSS. Additionally, it includes some extra configurations and tools. Please note: This default Laravel development environment is based on my personal preferences and is not intended to be a universal setup.

Main Features

• Laravel Framework (version 10.x)
• Laravel Breeze (providing Inertia.js, Vue.js, TypeScript, and Tailwind CSS)
• Momentum Trail (provides a front-end route() function similar to Laravel's)
• unplugin-auto-import and unplugin-vue-components (simplify importing Vue.js components and other modules)
• Laravel Sail (lightweight command-line interface for running Laravel in Docker containers, with MariaDB and Redis)
• ESLint (JavaScript code linting and formatting) with antfu/eslint-config (Anthony's ESLint config presets for easy setup)
• Laravel IDE Helper (assisting IDEs in understanding Laravel code structure)
• Lint-staged (code linting before commits)
• simple-git-hooks (Git hooks to automatically run lint-staged before commits)
• Vite (next-generation frontend development and build tool)
• Using pnpm instead of npm (faster and more efficient package manager)

How to Use

1. Clone this repository to your local machine:

git clone https://github.com/kevin82222/laravel-starter.git

2. Navigate into the project directory:

cd laravel-starter

3. Set up a Bash alias for Laravel Sail (optional, but recommended). Add the following line to your ~/.bashrc, ~/.bash_profile, or ~/.zshrc file:

alias sail='sh vendor/bin/sail'

Save the file and restart your terminal. You can now use the sail command instead of ./vendor/bin/sail. For more information, please refer to the official Laravel Sail documentation.

4. Start Laravel Sail:

sail up -d

5. Install dependencies:

sail composer install
pnpm install # because Sail not yet supported pnpm

6. Copy the .env.example file and rename it to .env:

cp .env.example .env

7. Generate an application key:

sail artisan key:generate

8. Run the development environment with Laravel Sail:

pnpm dev # ...

Now you can start developing with this personal default Laravel development environment!

Contributing

As this is a personal preference project, we might not accept contributions from others. However, feel free to fork this repository and modify it according to your needs.

License

This repository is released under the MIT License.