README.md

trello-json-to-markdown

trello-json-to-markdown is a Node.js script that generates reports for your Trello boards within a range of days as GFM Markdown files for easy viewing of the cards you have created and the details for each card, including the history of all of the actions for each card.

Installation

Clone the git repository via https:

$ git clone https://github.com/mpirik/trello-json-to-markdown.git

And then install the dependencies:

$ npm install

Install Grunt CLI:

$ npm install -g grunt-cli

Usage

First you'll need to obtain your Trello developer key and application token.

Developer Key

Follow this link. The value in the Key field is your developer key.

Application Token

Once you have your developer key, then modify this URL accordingly:

https://trello.com/1/authorize?key=substitutewithyourdeveloperkey&scope=read&name=My+Application&expiration=never&response_type=token

1. Replace substitutewithyourdeveloperkey with your developer key.
2. Replace My+Application with your application's name. This application is trello-json-to-markdown.
3. Enter the modified URL into your browser, and then click Allow.
4. The generated token is now your application's token that will never expire.

config.js

Now open up config.js. It should look like this:

//Replace 'your_key' with your key
module.exports.key = 'your_key';

//Replace 'your_token' with your application's token
module.exports.token = 'your_token';

//Put all of the desired boards' IDs into this array
module.exports.boards = ['boardID1', 'boardID2'];

Replace the key and token placeholders with your key and token. You'll also need to add the IDs of the boards you would like to generate reports for into to the boards array. To get the IDs of the boards you would like, simply execute:

$ node get-boards.js

This will list all of the boards the developer key is associated with in this format:

<board_name> ID: <board_id>

Execution

Once you have the configuration set up, execute the following command:

$ node trello-json-to-markdown.js <number_of_days_to_search>

Replace <number_of_days_to_search> with the amount of days you would like to search for. For example, to generate reports for the last 30 days from right now, execute:

$ node trello-json-to-markdown.js 30

The markdown files for your boards and cards will be dumped to their respective folders and files. For example:

+-- path-to-your-trello-board1
|   |
|   +-- path-to-your-trello-board1.md
|   |
|   +-- path-to-your-trello-board1-cards
|   |   |
|   |   +-- path-to-your-trello-board1-1.md
|   |   \-- path-to-your-trello-board1-2.md
|
+-- board2
|   |
|   +-- board2.md
|   |
|   +-- board2-cards
|   |   |
|   |   +-- board2-1.md
|   |   \-- board2-2.md

ESLint

ESLint is being used as a linting utility for this project. Before each commit, ESLint will check for any rule violations. To execute ESLint without committing, execute the following:

$ grunt eslint

Example

We'll run this against the trello-json-to-markdown board for the past 30 days.

$ node trello-json-to-markdown.js 30

You should now have the trello-json-to-markdown folder that contains the trello-json-to-markdown.md file and the trello-json-to-markdown-cards folder
Navigate into the trello-json-to-markdown folder and then open the trello-json-to-markdown.md file

You should see something similar to this file

Now open the trello-json-to-markdown-cards folder and then open the trello-json-to-markdown-3.md file

You should see something similar to this file