πŸ•-themed employee πŸ•‘-tracking bot for Slack
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.vscode
app
docs
test
.gitignore
.npmignore
.slugignore
.travis.yml
Dockerfile
LICENSE.md
Procfile
README.md
app.json
package.json
sample.ibizanrc.json
tsconfig.json
yarn.lock

README.md

Ibizan logo

πŸ•-themed employee πŸ•‘-tracking bot for Slack

Build Status Coverage Status Gratipay Team

Ibizan is a Slack bot built on the Botkit framework, originally contracted by Fangamer. Ibizan is designed to provide an intuitive and interactive interface to managing a timesheet.

Setup

This version of Ibizan is ready to be deployed to your Heroku with a little bit of setup. Future versions will be served as a Slack app, so consider the amount of control you want with this bot when using this method.

You must set up your configuration before running Ibizan or else it will not start.

Google Sheets Spreadsheet

In its current form, Ibizan punch functionality is tightly coupled to the layout of the spreadsheet it pulls from.

  1. Make a copy of this spreadsheet.
  2. Fill in all the relevant values in the "Variables" worksheet
  3. Add rows for each of your employees in "Users"
  4. Add a row for each name you want Ibizan to consider a project in "Projects". These are designed to correlate to channel names in Slack, but they don't have to.

Google Drive API Service Account

  1. Follow the instructions here
  2. When given the opportunity to download your keys, download it as JSON and save it somewhere safe. Google will only let you do this once, so if you lose it, you won't be able to get it back.
  3. Share your spreadsheet (the one you just created) with the email address given in the downloaded JSON.
  4. Make note of the client email, the private key, and the spreadsheet ID.

Deploying to Heroku

Deploy

Click the button above to automatically deploy an Ibizan to Heroku. Make note of the app name and FQDN, because you'll need them in the next section.

After deploying to Heroku, you'll need to set the following environment variables:

IBIZAN_PORT = <port to run the server from>
IBIZAN_STORAGE_URI = <url to a firebase instance for database>
IBIZAN_SLACK_CLIENT_ID = <slack app client id>
IBIZAN_SLACK_CLIENT_SECRET = <slack app client secret key>
IBIZAN_SLACK_VERIFICATION_TOKEN = <slack app verificiation token>
IBIZAN_GOOGLE_CREDENTIALS = <file path to your Google Service Auth JSON>

If Ibizan doesn't automatically start after you finish setting all the environment variables, use the Heroku Toolbelt to run heroku restart --app={YOUR APP NAME} in the terminal.