diff --git a/.env.example b/.env.example index 7d665fc..8e4a2a0 100644 --- a/.env.example +++ b/.env.example @@ -12,4 +12,8 @@ WEBHOOK_PROXY_URL=https://smee.io/ZyQCjZTDPT3pd4SD SLACK_BOT_TOKEN= # A "User Legacy Token" of your Slack App, used to access the "users.profile.get" API -SLACK_USER_TOKEN= \ No newline at end of file +SLACK_USER_TOKEN= + +# Bot configuration (optional) +# +# DRY_RUN_BOUNTY_APPROVAL=true diff --git a/README.md b/README.md index 0fbcd90..91516ad 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,23 @@ Right now the bot has two sets of capabilities: The project board names, column names, welcome message and other values are stored in the `.github/github-bot.yml` file. It can be overriden for each specific repository by adding a file in the same path on the respective repository (see [probot-config](https://github.com/getsentry/probot-config)). +## Development + +To get your environment set up go through the following steps: + +1. Run `npm install` +2. Populate `.env` + + ```sh + cp .env.example .env + # edit .env file to contain proper config + ``` + +After this you can start the bot by running: +```sh +npm start +``` + ## Creating the bot GitHub App This bot is meant to be packaged as a GitHub App. There are two steps to it: creating the app, and installing the app. Creating a GitHub App only needs to be done once and the app can be made public to be reused for any number of repositories and organizations.