Skip to content

GUI for managing custom workflows in Plone

collective/workflow-manager

Repository files navigation

Volto Workflow Manager

Volto Workflow Manager is a visual workflow editor for Plone.
It lets you create, manage, and edit workflows inside the Volto UI using a simple graph-based interface.


Installation

This package is a Volto add-on. To install it in your Volto project:

  1. Add workflow-manager to your project's package.json:

    {
      "addons": ["workflow-manager"]
    }
  2. Install dependencies:

    pnpm install
  3. Start the Volto development server:

    pnpm start

How to Use

  1. Open the Control Panel and select Workflow Manager.
  2. Create a new workflow if one does not exist.
  3. Add states and transitions using the graph interface.
  4. Edit state and transition details from the sidebar.
  5. Assign permissions and roles as needed.
  6. Save changes using the Volto toolbar.

Development Setup

If you want to contribute or customize the add-on locally:

Requirements

Installation

  1. Clone the repository:
git clone https://github.com/Manas-Kenge/workflow-manager.git
cd workflow-manager
  1. Install dependencies for both Backend and Frontend:
make install

Start the Servers

  1. Start the Backend (Plone) at http://localhost:8080/:
make backend-start
  1. In a new terminal, start the Frontend (Volto) at http://localhost:3000/:
make frontend-start

Your Plone development environment is now live!

License

This project is licensed under the MIT License.

About

GUI for managing custom workflows in Plone

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published