Helps configure your new Laravel project with good practices.

1.1.3 2025-08-02 16:11 UTC

This package is auto-updated.

Last update: 2025-08-02 16:11:38 UTC


README

PHP Linting (Pint) Test

πŸš€ Kickoff

This package bootstraps a new Laravel project with all the essential tools, configs, and workflows you need for a modern and maintainable setup.

The setup is based on this repository - Project Template.

✨ Features

  • πŸ“¦ Installs required Laravel packages:

  • πŸ›  Dev tools:

  • βš™οΈ Configuration:

    • Adds QA scripts to composer.json
    • Autoloads support/helpers.php
    • Creates rector.php, phpstan.neon.dist, and pint.json
  • πŸ“‚ Project Structure:

    • support/ for helpers
    • Refactored routes/ into web/, api/, and console/ subfolders (backups included)
    • tinker/ with .gitignore
    • docs/README.md with a placeholder TOC
  • πŸ›‘οΈ Automation Scripts:

    • Creates executable scripts in bin/ for tasks like backup, deployment, PHPStan reporting, dependency updates, and project install
    • All scripts use the current directory name as the project name
  • βœ… Testing:

    • Generates tests/Feature/ArchitectureTest.php using Pest Arch
  • πŸ“ Documentation:

    • Creates CHANGELOG.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, SUPPORT.md, and LICENSE.md
  • ⚑ GitHub Actions Workflows:

    • Pint (Laravel Pint)
    • PHPStan
    • Rector
    • Tests (Pest)
    • Changelog updater
  • πŸ”§ Artisan & Project Tasks:

    • Clears config and view caches
    • Runs migrations
    • Creates storage symlink
    • Publishes package configs and migrations
  • πŸ› οΈ Infrastructure Templates:

    • Sets up .config/ with Nginx and Supervisor templates

πŸ›‘οΈ Automation Scripts

  • Creates executable scripts in bin/ for common project tasks:

    • backup-app: Backup your application files
    • backup-media: Backup only media files changed in the last 24 hours
    • build-fe-assets: Build and commit frontend assets
    • deploy: Deploy code to your server with branch/tag support
    • update-dependencies: Update Composer and npm dependencies, audit and build assets
    • reinstall-npm: Remove and reinstall npm modules and lock file
    • install: Project initialization, database setup, and environment configuration
    • phpstan: Run PHPStan and generate readable reports per identifier
  • All scripts use the current directory name as the project name for dynamic configuration.

  • Scripts are made executable and can be run directly from the bin/ directory.

πŸ“₯ Usage

⚠️ This script is for new Laravel projects only. Do not run on an existing project unless you know what you’re doing.

Install this package at global:

composer global require cleaniquecoders/kickoff

Then run:

kickoff start <project-name> <project-path>