Preparing for Development

Set up

  1. Clone the git repository
  2. Copy .env.example to .env and update the variables there.
    • The SLACK_API_TOKEN specifies which Slack bot Zayo will access Slack as.
    • If you want to use the google calendar integration, create an API Key here: https://console.developers.google.com/apis/dashboard
    • Ask someone for access to the Wit.ai dev project, or create a new one
  3. Start the bot using docker-compose up -d --build
  4. If you've created a new Wit.ai project, run docker-compose exec zayo bin/update-wit to "teach" Wit.ai. This is asynchronous to the command and may take some time. You can watch that on Wit.ai's dashboard.
  5. Go to Slack and say hi to the bot.

During development

If changing core functionality, add unit tests for that. See spec/skill_spec.rb for a lot of examples. Tests can be run using bin/test (not currently docker-aware).

Before you make a PR

  1. Make sure the tests pass
  2. Run and test manually the interactions you have changed