Getting started

Getting Started

0. Setting up your environment

Add these entries to your .bash_profile (or .zprofile if you use zsh):

export GITHUB_USERNAME="yourusername"
export GITHUB_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
export TERLLO_API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
export TRELLO_API_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

1. Installing Node.js

Check if Node.js is already installed

If you already have Node.js, you can skip to step 2. To check if Node is already installed, open a new Terminal or Console window and type:

node -v

If vx.xx.xx is returned, you're good to go. If you see an error like command not found, Node.js is not installed on your system. Note that Sake requires node 8.9.4+

Download and Install

Download an installer for your platform and follow the on-screen instructions to install.

Alternatively you can use Homebrew on OS X to install:

$ brew update && brew install node

2. Installing sake

Sake needs to be installed for each plugin repo you're working with, although only once for multi-plugin repos. We'll use Node's package manager (NPM) to install Sake. Type the following in your command-line tool of choice.

cd path/to/project/
npm i skyverge/sake # this should only be run on repo that is not using sake yet
npm update # run this when you've cloned an existing plugin repo that already is using sake

This will install the sake command locally, allowing it to be run from the repo directory with npx, ie npx sake config