Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/eea/volto-workflow-progress

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/eea/volto-workflow-progress
Owner: eea
License: mit
Created: 2020-11-17T13:36:42.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-04-22T18:41:55.000Z (7 months ago)
Last Synced: 2024-07-24T16:31:40.634Z (3 months ago)
Language: JavaScript
Size: 7.25 MB
Stars: 1
Watchers: 38
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-volto - volto-workflow-progress - Shows workflow steps for content editors. (Addons / Rich text editing)

README

        # volto-workflow-progress

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

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

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

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

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

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

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

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

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

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

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

[Volto](https://github.com/plone/volto) add-on to give Plone Content Editors an overview of Document's publication workflow progress.

## Features

### Demo - Customize Workflow state's percentage via ZMI

[![Workflow Progress](https://raw.githubusercontent.com/eea/volto-workflow-progress/master/docs/volto-workflow-progress.gif)](https://youtu.be/MV2_23_dBkc?si=8nHRxqQmnj8yy1Cb)

## Dependencies

### Backend

- [Plone](https://plone.org/download)

- [plone.restapi](https://pypi.org/project/plone.restapi/)

- [eea.progress.workflow](https://pypi.org/project/eea.progress.workflow)

## Getting started

### Try volto-workflow-progress with Docker

      git clone https://github.com/eea/volto-workflow-progress.git

      cd volto-workflow-progress

      make

      make start

Go to http://localhost:3000

### Add volto-workflow-progress 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-workflow-progress"

   ],

   "dependencies": {

       "@eeacms/volto-workflow-progress": "*"

   }

   ```

* If not, create one:

   ```

   npm install -g yo @plone/generator-volto

   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-workflow-progress

   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-workflow-progress/blob/master/RELEASE.md).

## How to contribute

See [DEVELOP.md](https://github.com/eea/volto-workflow-progress/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-workflow-progress/blob/master/LICENSE.md) for details.

## Funding

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