russdanner / plugin-studio-kanban-base

Trello Workflow Plugin for CrafterCMS

Add a the ability to view and link to Trello boards in your Studio project

Installation

Install the plugin via Studio's Plugin Management UI under Site Tools > Plugin Management. You will need the following information:

• Trello API Key
• Trello API Token
• The ID of a board to load if no boardId is provided in the Sidebar widget configuration
• A Studio JWT token for Trello callbacks to Studio

Generating Keys for Trello

1. Go to the following URL to generate a Trello API Key https://trello.com/app-key

2. Invoke the following URL to generate a Trello API Token https://trello.com/1/authorize?expiration=never&name=CrafterCMS&scope=read,write&response_type=token&key={YOUR_KEY}

You may alter name and expiration parameters as is desired.

Adding more than one Trello board to a project

You may add as many boards to your Sidebar as you like by adding the widget to Studio's UI.xml and specifying the board ID:

<widget id="org.rd.plugin.trellowf.openBoardButton">
    <plugin
        id="org.rd.plugin.trellowf"
        site="{site}"
        type="apps"
        name="trellowf"
        file="index.js"
    />
    <configuration>
        <title>News Workflow</title> 
        <icon id="@mui/icons-material/CodeRounded"/>
        <boardId>A0ID0HERE0</boardId>
    </configuration>
</widget>

Hooks

Each board will auto register for hooks. You can monitor these here. Localhost instances and servers which are not reachable by Trello do not get registered. https://STUDIOSERVER/studio/plugin?site=A_SITEID_HERE&type=apps&pluginId=org.rd.plugin.trellowf&name=trellowf&file=app.js#/hooks

Screenshots