Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 3.9 KB

README.md

File metadata and controls

68 lines (42 loc) · 3.9 KB

A collection of scripts using trello API to enforce respect of process @ 360Learning

# Setup

Getting your Trello API credentials

  • Generate your developer key
  • To read a user’s private information, get a token by directing them to https://trello.com/1/connect?key=<PUBLIC_KEY>&name=MyApp&response_type=token replacing, of course, <PUBLIC_KEY> with the public key obtained in the first step.
  • If you never want the token to expire, include &expiration=never in the url from the previous step.
  • If you need write access as well as read, &scope=read,write to the request for your user token.

## Setting your credentials as environment variables

export TRELLO_API_KEY=your_key_here
export TRELLO_TOKEN=your_token_here

## Running the scripts Each script is documented in its header. To launch them, you probably need to edit some IDs. Then this is as simple as :

node script.js

You can also put them in your crontab :

# product bot
*/15 * * * * /home/deploy/.nvm/versions/node/v6.9.1/bin/node /var/www/productbot/enforce_product_template.js Care && curl -fsS --retry 3 https://hchk.io/d033366b-f8d8-48f8-b2f7-bcb725432c9f > /dev/null
*/15 * * * * /home/deploy/.nvm/versions/node/v6.9.1/bin/node /var/www/productbot/enforce_product_template.js Imagine && curl -fsS --retry 3 https://hchk.io/e1bb5c8b-c4bd-4324-b7c0-14489191be11 > /dev/null
*/15 * * * * /home/deploy/.nvm/versions/node/v6.9.1/bin/node /var/www/productbot/enforce_product_template.js Conquer curl -fsS --retry 3 https://hchk.io/ffad8ab4-7e2e-4342-abaa-7de3ee956302 > /dev/null
*/15 * * * * /home/deploy/.nvm/versions/node/v6.9.1/bin/node /var/www/productbot/enforce_product_template.js Universities && curl -fsS --retry 3 https://hchk.io/2e05a929-c8b2-45b2-a843-c4507985866c > /dev/null
*/15 * * * * /home/deploy/.nvm/versions/node/v6.9.1/bin/node /var/www/productbot/enforce_product_template.js Engage && curl -fsS --retry 3 https://hchk.io/2863f42e-c71f-4479-a21e-1fd3ae2f235f > /dev/null

The example cron config above make use of https://healthchecks.io free monitoring service. Should your cron job fail or not even start, you will receive an alert email.

Beware : Remember to export your environment variables in /etc/environment to have them loaded and available for cron.

Style guide

This project relies onairbnb's javascript repo style guide.

## Linters

In order to enforce this coding style and improve code quality with automatic tools, this repo is configured to use eslint. To use it, you first have to install it (global installations provides easier integration) :

    npm install -g eslint

Eslint will check the js files against a set of rules that we can customize as we want (configure your editor to lint on the fly to have immediate feedback when you code). Those rules are defined in files named .eslintrc at the root of every module (all our modules doesn't need the same rules.).

One of the most famous style guide is airbnb's. Our .eslintrc file has been imported from this ruleset (for es5).

## Editors to the rescue Tweaking the config of your text editor can make the adoption of multiple practices totally painless. To share some of these configs efficiently across editors, there is a convenient standard named editorconfig used to specify the conventions for the project (tabs vs spaces, indent size, trim trailing whitespaces... ). That's the reason why there is a .editorconfig file at the root of the project, which can (and should) be coupled with plugins on all major editors to import those settings.

You should also configure your text editor to use your linter on the fly, it's awesome (lot of ressources on the web about it. Google it!).