https://github.com/instification/volto-plone-reloader

https://github.com/instification/volto-plone-reloader

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/instification/volto-plone-reloader
• Owner: instification
• License: mit
• Created: 2022-10-13T06:57:23.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-14T10:46:16.000Z (about 2 years ago)
• Last Synced: 2024-12-06T21:08:42.843Z (about 1 month ago)
• Language: JavaScript
• Size: 315 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-volto - volto-plone-reloader - Use [plone.reload](https://github.com/plone/plone.reload)'s `/@@reload` feature through a volto frontend (Addons / Plone backend add-ons for Volto)

README

        
An add-on to pass `/@@reload` to the backend.

## Overview

The Plone addon [plone.reload](https://pypi.org/project/plone.reload/) provides a code reloader for your Plone backend.

Unfortunately this currently does not work through a Volto frontend as the route is unknown and the request doesn't get to the backend. Instead you must run it from a different window or tab directly on the backend.

This addon aims to resolve this problem by:

 - Creating an express middleware layer to forward requests to `/@@reload` to the backend.

 - Changes the `apiPath` to remove the Plone site (`@@reload` must be run from the zope root).

 - Adds VirtualHost parameters to the url to ensure the reload actions go through volto.

 - Authenticates the call with either admin:admin or admin:secret, the default credentials for plone dev instances.

## Installation

Add the addon to your projects `package.json`:

```

"addons": [

    "plone-volto-reloader"

],

"dependencies": {

    "plone-volto-reloader": "*"

}

```

Install the add-on and restart Volto:

```

yarn

yarn start

```

Then the reload middleware will be accesible via http://localhost:3000/@@reload

## Credits

Jon Pentland ([instification](https://github.com/instification))