Set up

Set up Cade in minutes. One command guides you.

You get one Cloudflare Worker, one Slack app and, if you like, a Google Doc for executive summaries. There's no server to run. One command, npm run setup, does the setup with you: it runs each step, checks it worked, and stops whenever it needs you to click something.

  1. 1

    Copy the deploy template to your own repo

    On the cade-deploy page, click Use this template and make the copy private. It holds your settings, and the setup asks which version of Cade to deploy: a release, or the latest. Then clone it:

    git clone https://github.com/<you>/<your copy>.git cade-deploy
cd cade-deploy
  2. 2

    Run the setup

    In your cade folder run:

    npm run setup

    It skips what's already done, so if you stop, run it again to carry on.

  3. 3

    Follow along

    Each step says what it's doing. It stops and tells you exactly what to do when a step needs a person:

    • Logging in to Cloudflare, and to Google for the Doc, in your browser
    • Making a Slack app configuration token, and installing the app
    • Giving the first admin's Slack member ID. Then, in Slack, you create a channel, invite Cade, and click Add project on its Home tab
  4. 4

    Try it

    Send /cade task in your dev channel to track a task, or, on any message anywhere, choose ⋯ → More actions → New task. Send /cade help for the short list, or see the demo and every command.

What the setup does

Nine steps, most of them done for you

Steps marked You need a click in your browser; the setup waits for you.

  1. Get the code and run the tests
  2. Log in to CloudflareYou
  3. Deploy the Worker
  4. Get a Slack app configuration tokenYou
  5. Create the Slack app
  6. Install the app and store its tokenYou
  7. Set up the channels
  8. Optional: the Google Doc
  9. Check it works

Prefer to do it yourself? The same steps, with what to expect and what to do if one fails, are in GETTING_STARTED.md.

Step-by-step guide →