/volto-workflow-progress

Primary LanguageJavaScriptMIT LicenseMIT

volto-workflow-progress

Releases

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

Pipeline Lines of Code Coverage Bugs Duplicated Lines (%)

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

Dependencies

Backend

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 up-and-running at http://localhost:8080/Plone

    docker compose up backend
  2. Start Volto frontend

  • If you already have a volto project, just update package.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
    
  2. Go to http://localhost:3000

  3. Happy editing!

Release

See RELEASE.md.

How to contribute

See DEVELOP.md.

Copyright and license

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

See LICENSE.md for details.

Funding

European Environment Agency (EU)