Skip to content

Latest commit

 

History

History
128 lines (96 loc) · 4.61 KB

README.md

File metadata and controls

128 lines (96 loc) · 4.61 KB
Raw

Welcome to gimme-cards-mate 👋

Version Documentation Maintenance Twitter: michalczukm

Trello power-up which allow you to generate formated document filled with your cards on a Trello list.

In action

in action gif

In editor you have access all cards on the list and to render functions. Both should be suggested by autocomplete.

type List = {
    name: string,
    cards: {
        id: string,
        name: string,
        desc: string,
        url: string,
        shortUrl: string,
        attachments: { id: string, name: string, url: string, date: string }[],
        labels: { id: string, name: string, color: string }[]
    }[]
};

declare const LIST: List;

declare const render: {
  write(content: string): void,
  newLine(): void;
  writeLine(content: string): void,
  list(items: string[], type: 'ordered' | 'unordered' = 'unordered'): void
}

Adding this Trello power-up to your board

You can use custom (non marketplace power-up) only in the Trello team that you're administrating.

Please make sure you have one, if you want to use this.

  1. Visit trello.com/power-ups/admin and press Create new power-up Create new power-up
  2. Fill form, if you want to use my distribution, put https://michalczukm.github.io/trello-gimme-cards-mate/ as iFrame connector URL. Click Create. New power-up form
  3. Set power-up capabilities - those are entry points where it can be rendered. Set list-actions to true. New power-up form
  4. Visit trello.com/app-key, and add https://michalczukm.github.io/trello-gimme-cards-mate/ to list of allowed URLs to redirect after authorization flow. You can also add there wildcard *, but I wouldn't do this if I were you 🤓 New power-up form
  5. Go to board which, you'd like to add power-up to. Please remember that it has to be in the same team. And add a custom power-up New power-up form
  6. Gimme cards mate should be available in list meatballs menu. Before first run you'll have to authorize it for reading your data (it reads cards from the list, remember? 🙃). New power-up form

Install

npm install

Usage

Before running it:

Run and serve via webpack-dev-server

npm start

Build production assets

npm run build

Running local dev on Trello

To run you local version on Trello you have to expose it on the internet over HTTPS, and use that address as iFrame connector URL [(as here)].(#adding-this-trello-power-up-to-your-board)

You can use services like ngrok for that.

For ngrok you have to add extra headers when exposing webpack-dev-server.

# assuming that your webpack-dev server runs on port 8080
ngrok http 8080 --host-header="localhost:8080"

To make your app complete authorization flow - you have to allow this origin for authorization redirect from Trello in app-key.

Do the same step (as here), but with your own URL.

More information

Developing Trello power-ups

Author

👤 Michal Michalczuk

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 Michal Michalczuk.
This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator