igorsgm/laravel-assembler

🧰 • An extended Laravel Installer CLI that gives you the power to scaffold a new Laravel project with some neat add-ons and set up a git repository in a single command.

v0.5.0 2022-10-22 08:13 UTC

Requires

• php: ^7.3|^8.0
• ext-json: *
• laminas/laminas-text: ^2.9
• laravel/installer: ^4.2

Requires (Dev)

• laravel-zero/framework: ^9.2
• laravel/pint: ^1.2
• mockery/mockery: ^1.4.4
• pestphp/pest: ^1.21.3

MIT

• Igor Moraes

• framework
• php
• cli
• installer
• console
• laravel
• artisan
• extended

README

An extended Laravel Installer CLI that gives you the power to scaffold a new Laravel project and set up a git repository in a single command.

✨ Features

• Simple setup process
• Integrate with Laravel IDE Helper Generator to improve code completion in your IDE
• Integrate with PHP_CodeSniffer to improve the code quality of your project
• Setup a GitHub repository with and easy to customize README
• Setup Gitflow Workflow
• Create a git pre-commit-hook to validate PHPCS before committing a code
• Custom composer scripts to make your live simpler
• Laravel Valet integration: secure your project with SSL
• Open the project automatically in your browser + PhpStorm once the installation finishes

In a single script!

Don't want to use any of the above features? No problem, all are optional.

1️⃣ Requirements

• Mandatory:

  • PHP 7.3 or higher
  • Composer

  Make sure to place Composer's system-wide vendor bin directory in your $PATH so the laravel-assembler executable can be located by your system. This directory exists in different locations based on your operating system; however, some common locations include:

  • macOS: $HOME/.composer/vendor/bin
  • Windows: %USERPROFILE%\AppData\Roaming\Composer\vendor\bin
  • GNU / Linux Distributions: $HOME/.config/composer/vendor/bin or $HOME/.composer/vendor/bin

• Optional:

  • GitHub CLI with your user properly logged in: to create the repository for your new project -- the logged in user is going to be the owner of the repo.
  • gitflow-avh: to start git flow in your project.
  • Laravel Valet: to set up a SSL certificate and open the project in the browser automatically.
  • Jetbrains CLI's Launcher for a standalone instance: if you wish to open the project immediately on PhpStorm.

2️⃣ Installation

composer global require igorsgm/laravel-assembler

3️⃣ 🚀 Creating a new project

laravel-assembler new my-cool-project-name

• It will ask you a few questions during the process to help you get started and generate a new laravel project accordingly to your preferences.
• When the script finishes you should have a my-cool-project-name folder the path that you run your script.
• Voilà!

⚙️ Available commands