Repository files navigation

A ready-to-use Laravel development environment, optimized for GitHub Codespaces.This template provides a seamless, zero-setup experience for Laravel developmentin the cloud.

• Pre-configured Dev Container: Uses Docker Compose to orchestrate PHP 8.2(LTS), Node.js 18 (LTS), and MySQL 8.0 (LTS) services.
• MySQL Pre-installed and Running: MySQL 8.0 is included as a service in thedev container—no need to install or configure a database server manually.
• VS Code Extensions: Installs recommended extensions for Laravel, PHP, andDocker development.
• Automated Setup: Handles dependency installation, environment setup, anddatabase migrations automatically on first launch.
• Correct Permissions: Ensures storage and cache directories are writable forLaravel.

• Laravel Version: 12.19.3 (latest as of July 2025)
• Standard Structure: Includes all default Laravel directories and files(app/,config/,database/,routes/, etc.)
• No Custom Packages: Clean install, ready for your customization.

• Automated Dependency Installation: Runscomposer install andnpm install on first start.
• Automatic.env Setup: Copies.env.example to.env and configuresdatabase credentials for the Codespace environment.
• Database Prepared Automatically: The MySQL database is created, ready, andall migrations are run for you—no manual steps needed.
• Pre-installed VS Code Extensions: Includes extensions for Blade, PHPIntelephense, Laravel snippets, and more.
• Writable Storage/Cache: Ensuresstorage/ andbootstrap/cache/ arewritable by the application.

1. You can get started with this template in several ways:

   • Open a Codespace directly from GitHub:
     • If this repository is public, you can click the "Code" button on therepo page and select "Create codespace on main" (or another branch).No need to fork or clone first — GitHub will automatically provision aCodespace with the repo contents and devcontainer setup.
   • Fork the repository:
     • If you want your own copy of the repository (for making changes orkeeping your own Codespace), fork it on GitHub, then open a Codespacefrom your fork.
   • Manual setup using the devcontainer:
     • You may also copy the.devcontainer folder/configuration to anotherproject or environment to reuse the same development setup. This isonly recommended if you know what you are doing — your project may notwork at all if the environment is not compatible or is missingrequired services.

2. Wait for Setup: The container will build, dependencies will be installed,and the database will be prepared automatically. As soon as the Codespace isavailable, you can open thesetup-status.log file in the project root towatch the automated setup progress and verify it completed successfully.

3. Start the Laravel Development Server: Run the following command in theterminal to start the app and make it accessible:

   php artisan serve --host=0.0.0.0 --port=8000

4. Open in Browser: Once the app is running, a pop-up may appear inCodespaces with an "Open in Browser" button for port 8000. If you miss it,you can always go to the "Ports" tab, find port 8000, and click "Open inBrowser". (The URL will be a Codespaces-specific address, not localhost.)

This template is provided under the MIT License. SeeLICENSE forfull details.