Starters & Tutorials

Getting started

First you need to add Troglio as a custom power-up.

For this, you need to go to your power-up's admin interface to add a new Power-Up.
If you didn't created a team yet, you can create one now (Power-Ups need a team).
Once you selected your team, just click on "Create a new Power-Up", fill the form like this:

Once you have added the Power-Up, you are good to go !! Just go to any board in the selected team and add your custom Power-Up named Troglio:

Why Troglio is not available directly into Trello ?!

We presented Troglio in front of Trello and received a very good attention and interest. However, we agreed upon the fact that Troglio is a bit more advanced than the average Power-Up. Precisely, Troglio is out of the scope of Trello's average user base since it requires to come with its app/website to find an interest in using Trello + Troglio (the very concept of headless CMS is not for common Trello users).

For this reason, Trello expressely encouraged us to promote Troglio this way (out of Trello). Having the power-up available from their public listing could lead to confusion since common Trello users do not have any website/app just yet and could think of Troglio as a classic monolithic solution (in contrast with a headless CMS).

Now, there is absolutely no difference nor limitations on installing a custom power-up manually with Trello. Just go ahead a try now !!

The guide

Push or Pull ?

After connecting Troglio to your Trello account, you are asked to setup a destination for your data. By default, Troglio only pushes data to this destination. In most cases, this is fine because one can take advantage of Continuous Integration pipelines to trigger builds whenever new data arrives in their git.

However, if you prefer pulling data, you can easily send them to a server that will act as your API endpoint. There are two different approches to do that:

Send data to a git repository, like github, that will trigger a CI build responsible for publishing .json files (to github pages, netlify, or any CDN...).

Previews

Previews is a neat feature that allows one to instantly see changes before publishing them live. This is not a mandatory option, but is for sure a must-have for writers and marketers. For it to work, it requires a separate url to be setup. The url is nothing more than the public domain of the website. For example, if the final website lives at https://mydomain.com, just put this url in the related setup (by clicking the Preview button in any card for the first time, or by going in the power-up's settings).

How it works ?
Basically, Troglio will create JSON pages out of Trello cards right in the browser. When a user requests a preview, Troglio opens an iFrame containing both the corresponding page + the new data.

As a developer it means that, when your website is opened through an iFrame, you should intercept these new data and propagate them accordingly to fill your templates, live.

If you use a Javascript framework (like React), it is a piece of cake: just catch the new data and propagate them into your routes as new props. Here is a snippet illustrating the point(PAY ATTENTION TO COMMENTS).

Support

This is a nice place to keep technical problems centralized :)
If you have any problems related to developping apps and websites with troglio, please just fill an issue here.