Givvy

Deploy to Heroku

One click deploy

Setting up your Slack App

You must setup your own Slack App manually.

To do this, click this link to begin.

You should setup the following:

• Slash Commands:
  • /give points to <your_heroku_url>/api/v1/slack
  • /redeem points to <your_heroku_url>/api/v1/slack_redeem
• OAuth Permissions:
  • chat:write:bot to post as a bot
    • users:read to read & validate users
    • users:read.email for future features

Improve performance with caching avatars

TODO

ENV vars

This project uses dotenv gem to load .env (sample in .env.sample file)

SLACK_TOKEN= Copy and paste OAuth token from Slack here, after creating your Slack app

ADMIN_PASSWORD=givvy Password to access admin panel

TZ="Asia/Ho_Chi_Minh" Default timezone

DEFAULT_ALLOWANCE=150 Default allowance per user per month

ANNOUNCE_MODE="in_channel" Send announcement in-channel, where the user posted the command. Other value is "public".

DEFAULT_CHANNEL="#general" If announcement mode is public, then the response message will be posted into this default channel.

Tech stack

• Ruby 2.3
• Rails 5
• Postgres DB
• Custom .buildpacks to enable wkhtmltoX