Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eea/volto-controlpanel

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/eea/volto-controlpanel
Owner: eea
License: mit
Created: 2024-03-13T12:24:39.000Z (11 months ago)
Default Branch: master
Last Pushed: 2024-11-18T09:14:51.000Z (2 months ago)
Last Synced: 2024-11-18T10:28:47.795Z (2 months ago)
Language: JavaScript
Size: 583 KB
Stars: 1
Watchers: 25
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-volto - volto-controlpanel - Enhance Version Overview information in Control Panel. Requires `eea.api.controlpanel` Plone backend add-on. (Addons)

README

        # volto-controlpanel

[![Releases](https://img.shields.io/github/v/release/eea/volto-controlpanel)](https://github.com/eea/volto-controlpanel/releases)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-controlpanel%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-controlpanel/job/master/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-controlpanel-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-controlpanel-master)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-controlpanel-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-controlpanel-master)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-controlpanel-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-controlpanel-master)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-controlpanel-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-controlpanel-master)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-controlpanel%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-controlpanel/job/develop/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-controlpanel-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-controlpanel-develop)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-controlpanel-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-controlpanel-develop)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-controlpanel-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-controlpanel-develop)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-controlpanel-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-controlpanel-develop)

[Volto](https://github.com/plone/volto) add-on that enhance Version Overview information in Control Panel:

* Frontend Version

  * When it was updated and from which version

  * Link to Frontend changelog

  * Volto version and the list of all installed Volto add-ons

* Backend Version

  * When it was updated and from which version

  * Link to Backend changelog

  * List of all Python eggs installed on Backend

## Requirements

This addon requires a server-side package to be installed.

* [eea.api.controlpanel](https://github.com/eea/eea.api.controlpanel?)

## Features

![Volto Control Panel](https://raw.githubusercontent.com/eea/volto-controlpanel/master/docs/volto-controlpanel.gif)

## Environment Variables

You can control the information displayed in Volto Control Panel via the following environment variables:

* `RAZZLE_CHANGELOG_PREFIX` - Default: `https://github.com/eea` - Used to compose the links to CHANGELOG

* `RAZZLE_CHANGELOG_SUFFIX` - Default: `releases` - Used to compose the links to CHANGELOG

* `RAZZLE_FRONTEND_VERSION` - Default: `` - Frontend version

* `RAZZLE_FRONTEND_NAME`    - Default: `` - Used to compose the links to CHANGELOG

* `RAZZLE_BACKEND_VERSION`  - Default: `''` - Backend version

* `RAZZLE_BACKEND_NAME`     - Default: `plone-backend` - Used to compose the backend link to CHANGELOG

## Getting started

### Try volto-controlpanel with Docker

      git clone https://github.com/eea/volto-controlpanel.git

      cd volto-controlpanel

      make

      make start

Go to http://localhost:3000

### Add volto-controlpanel to your Volto project

1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone

   ```Bash

   docker compose up backend

   ```

1. Start Volto frontend

* If you already have a volto project, just update `package.json`:

   ```JSON

   "addons": [

       "@eeacms/volto-controlpanel"

   ],

   "dependencies": {

       "@eeacms/volto-controlpanel": "*"

   }

   ```

* If not, create one:

   ```

   npm install -g yo @plone/generator-volto

   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-controlpanel

   cd my-volto-project

   ```

1. Install new add-ons and restart Volto:

   ```

   yarn

   yarn start

   ```

1. Go to http://localhost:3000

1. Happy editing!

## Release

See [RELEASE.md](https://github.com/eea/volto-controlpanel/blob/master/RELEASE.md).

## How to contribute

See [DEVELOP.md](https://github.com/eea/volto-controlpanel/blob/master/DEVELOP.md).

## Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA).

All Rights Reserved.

See [LICENSE.md](https://github.com/eea/volto-controlpanel/blob/master/LICENSE.md) for details.

## Funding

[European Environment Agency (EU)](http://eea.europa.eu)

Funding

[European Environment Agency (EU)](http://eea.europa.eu)