Keeper

The devICT community Slack bot!

Development

Quick Start

Keeper be be ran from both your local CLI, as well as in Docker.

Local CLI

1. Run make build-dev-workspace
2. Populate the data in the newly generated .env file
3. You'll need 2 terminals to compile live.
   1. In one terminal, just run npm start
   2. In your other terminal, run make dev, which will compile your .ts files live

Now you can add commands to Keeper in lib/handlers/keeper.ts!

Interacting with the bot locally

1. Make sure it's running with npm start in one terminal
2. In another terminal, run nc localhost 3333 to open a tcp connection to the bot
3. Type commands and see responses! Try hello and you should see keeper: hello, Human! in response

Docker

NOTE As of now, there is no way to develop locally in docker.

To run your local build, run make build, then make start. Run make stop to kill the container.

Add your first Keeper command!

Head into Keeper's Handlers, where you can add your new command, and it's handler.

This file holds all of the command handlers for the commands that Keeper supports. It exports a map, which is the command and their handlers. The KeeperClient then takes this map, and registers all the commands with Slack.

To add your new command, add your command name to the KeeperSlackCommands enum. You can then create your handler in the Keeper's Handlers file, and add it to the exported map. Wallah, your command is now registered with Keeper!