https://github.com/maks-oleksyuk/laravel-composer-scaffold

🧰 A flexible Composer scaffold builder for Laravel project.
https://github.com/maks-oleksyuk/laravel-composer-scaffold

composer composer-plugin laravel scaffold

Last synced: 14 days ago
JSON representation

🧰 A flexible Composer scaffold builder for Laravel project.

• Host: GitHub
• URL: https://github.com/maks-oleksyuk/laravel-composer-scaffold
• Owner: maks-oleksyuk
• License: gpl-3.0
• Created: 2024-09-23T16:50:59.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-09-29T13:18:19.000Z (about 1 month ago)
• Last Synced: 2024-10-14T16:41:05.466Z (23 days ago)
• Topics: composer, composer-plugin, laravel, scaffold
• Language: PHP
• Homepage:
• Size: 20.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Laravel composer scaffold

[![CI](https://github.com/maks-oleksyuk/laravel-composer-scaffold/actions/workflows/ci.yml/badge.svg?branch=main)](//github.com/maks-oleksyuk/laravel-composer-scaffold/actions/workflows/ci.yml)

[![Laravel version](https://img.shields.io/badge/10%20%7C%2011-ff2d20?logo=laravel&label=Laravel&logoColor=fff)](//laravel.com 'Laravel')

[![Packagist Downloads](https://img.shields.io/packagist/dt/maks-oleksyuk/laravel-composer-scaffold?logo=packagist&label=Downloads&color=f28d1A&logoColor=fff)](//packagist.org/packages/maks-oleksyuk/laravel-composer-scaffold 'Packagist Downloads')

This project provides a Composer plugin that makes the Laravel Composer package work correctly in a Composer project.

It takes care of the following:

Placing the project files (such as `artisan`, `public/index.php`, ...) from the `laravel/laravel` to the desired

location at the root of the web page. Only single files can be placed using this plugin.

The purpose of scaffolding files is to allow Laravel sites to be fully managed by Composer.

This is done to allow a properly configured Composer template to create a file structure that exactly matches the

structure of the `laravel/laravel` files.

## Usage

Laravel Composer Scaffold is used by requiring `maks-oleksyuk/laravel-composer-scaffold` in your project, and providing

configuration settings in the extra section of your project's `composer.json` file.

Typically, the scaffold operations run automatically as needed, e.g. after `composer install`, so it is usually not

necessary to do anything different to scaffold a project once the configuration is set up in the project `composer.json`

file, as described below. To scaffold files directly, run:

```sh

composer laravel:scaffold

```

## Settings

By default, the plugin does not require any additional settings, so it will only work with the following files:

```text

artisan

.editorconfig

bootstrap/cache/.gitignore

public/.htaccess

public/index.php

public/favicon.ico

public/robots.txt

storage/app/.gitignore

storage/app/public/.gitignore

storage/app/private/.gitignore

storage/framework/cache/.gitignore

storage/framework/cache/data/.gitignore

storage/framework/sessions/.gitignore

storage/framework/testing/.gitignore

storage/framework/views/.gitignore

storage/framework/.gitignore

storage/logs/.gitignore

```

However, you can overwrite these settings by specifying the desired settings in the `composer.json` file:

```json

"extra": {

    "laravel-scaffold": {

        "files": [

            "artisan",

            ".editorconfig",

            "public/.htaccess",

            "public/index.php",

            "public/robots.txt"

        ]

    }

}

```