https://github.com/pattern-lab/plugin-php-reload

Automatic Browser Reload Support for Pattern Lab
https://github.com/pattern-lab/plugin-php-reload

Last synced: about 2 months ago
JSON representation

Automatic Browser Reload Support for Pattern Lab

• Host: GitHub
• URL: https://github.com/pattern-lab/plugin-php-reload
• Owner: pattern-lab
• License: mit
• Created: 2016-06-21T04:03:02.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-28T11:14:16.000Z (over 7 years ago)
• Last Synced: 2024-10-28T12:11:31.850Z (8 months ago)
• Language: PHP
• Homepage: http://patternlab.io/
• Size: 10.7 KB
• Stars: 7
• Watchers: 5
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![license](https://img.shields.io/github/license/pattern-lab/plugin-php-reload.svg)

[![Packagist](https://img.shields.io/packagist/v/pattern-lab/plugin-reload.svg)](https://packagist.org/packages/pattern-lab/plugin-reload) [![Gitter](https://img.shields.io/gitter/room/pattern-lab/php.svg)](https://gitter.im/pattern-lab/php)

# Reload Plugin for Pattern Lab

The Reload Plugin adds Web Socket-based automatic browser reload support to Pattern Lab. The Reload Plugin will automatically reload the Pattern Lab iFrame if you're using the `--watch` flag or `--server --with-watch` flag combo.

## Installation

To add the Reload Plugin to your project using [Composer](https://getcomposer.org/) type:

    composer require pattern-lab/plugin-reload

See Packagist for [information on the latest release](https://packagist.org/packages/pattern-lab/plugin-reload).

## Usage

The Reload Plugin is automatically turned on when you install it. Simply "watch" your project using the following command:

    php core/console --watch

You can also run your server and watch your project at the same time:

    php core/console --server --with-watch

## Disabling the Plugin

To disable the Reload Plugin you can either directly edit `./config/config.yml` or use the command line option:

    php core/console --config --set plugins.reload.enabled=false