https://github.com/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.
https://github.com/igorsgm/laravel-assembler
artisan cli console extended framework installer laravel php
Last synced: 4 months ago
JSON representation
🧰 • 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.
- Host: GitHub
- URL: https://github.com/igorsgm/laravel-assembler
- Owner: igorsgm
- License: mit
- Created: 2021-02-11T07:17:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-17T07:05:25.000Z (about 3 years ago)
- Last Synced: 2024-12-02T02:53:31.672Z (over 1 year ago)
- Topics: artisan, cli, console, extended, framework, installer, laravel, php
- Language: PHP
- Homepage:
- Size: 21.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
🧰 Laravel Assembler
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](https://github.com/barryvdh/laravel-ide-helper) to improve code completion in your IDE
- Integrate with [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) to improve the code quality of your project
- Setup a **GitHub repository** with and easy to customize README
- Setup [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/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](https://laravel.com/docs/master/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](https://cli.github.com) with your user properly [logged in](https://cli.github.com/manual/gh_auth_login): to create the repository for your new project -- *the logged in user is going to be the owner of the repo*.
- [gitflow-avh](https://github.com/petervanderdoes/gitflow-avh): to start git flow in your project.
- [Laravel Valet](https://laravel.com/docs/master/valet): to set up a SSL certificate and open the project in the browser automatically.
- [Jetbrains CLI's](https://www.jetbrains.com/help/phpstorm/working-with-the-ide-features-from-command-line.html) Launcher for a standalone instance: if you wish to open the project immediately on PhpStorm.
## 2️⃣ Installation
```sh
composer global require igorsgm/laravel-assembler
```
## 3️⃣ 🚀 Creating a new project
```sh
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
