Requirements

• Docker
• pre-commit

Running

Production

docker compose -f compose.prod.yaml up -d

Development

First time

pre-commit install
pre-commit install -t prepare-commit-msg
# Enable the custom sail venv
./bin activate
# Start services
sail up -d
# Set permissions to avoid conflicts with the container creating files as root
sudo chown -R $USER:$USER .
# Run the post-create-project-cmd script (creates app key, installs Octane, makes sqlite database and runs migrations)
sail composer run-script post-create-project-cmd
# Restart the services to apply the changes
sail restart

Subsequent times

./bin activate
sail up -d # -d is needed to run in the background

NOTE: bin/activate is a custom script that activates the custom sail venv. It is not included in the Laravel Sail package. It creates some aliases to avoid typing ./vendor/bin/sail every time. Also common commands like composer, php, artisan, npm, yarn, sail and sail-root are sent to the sail container.

Template routes

Method	URI	Name	Docs
GET|HEAD	/log-viewer	Log viewer	https://github.com/opcodesio/log-viewer
GET|HEAD	/pulse	Pulse dashboard	https://pulse.laravel.com
GET|HEAD	/telescope	Telescope dashboard	https://laravel.com/docs/11.x/telescope

Troubleshooting

Laravel pulse migrations not found

For some reason, the migrations for Laravel Pulse are not found when running php artisan migrate. To fix this, run the following command to run the Pulse migrations (already done in production environment):

sail php artisan migrate --path=vendor/laravel/pulse/database/migrations/2023_06_07_000001_create_pulse_tables.php

Webserver not starting

If you receive the following errors when starting the webserver:

WARN   unable to get instance ID; storage clean stamps will be incomplete.  
ERROR  could not clean default/global storage.  
ERROR  job failed.  

Then you have to set appropriate permissions to the container user (usually 1000:1000) on the .config, .data directories:

for dir in .config .data; do
    sudo chown -R <your_user>:1000 $dir && sudo chmod 0775 $dir
done

Fish version:

for dir in .config .data
    sudo chown -R <your_user>:1000 $dir && sudo chmod 0775 $dir
end

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

• Simple, fast routing engine.
• Powerful dependency injection container.
• Multiple back-ends for session and cache storage.
• Expressive, intuitive database ORM.
• Database agnostic schema migrations.
• Robust background job processing.
• Real-time event broadcasting.

Laravel is accessible, powerful, and provides tools required for large, robust applications.

Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.

In addition, Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.

You can also watch bite-sized lessons with real-world projects on Laravel Learn, where you will be guided through building a Laravel application from scratch while learning PHP fundamentals.

Agentic Development

Laravel's predictable structure and conventions make it ideal for AI coding agents like Claude Code, Cursor, and GitHub Copilot. Install Laravel Boost to supercharge your AI workflow:

composer require laravel/boost --dev

php artisan boost:install

Boost provides your agent 15+ tools and skills that help agents build Laravel applications while following best practices.

Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via taylor@laravel.com. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.

Credits

• Laravel Octane Dockerfile: https://github.com/exaco/laravel-octane-dockerfile
• Log viewer: https://github.com/opcodesio/log-viewer
• Laravel Pulse: https://pulse.laravel.com
• Laravel Debug Bar: https://github.com/barryvdh/laravel-debugbar