Skip to content

Latest commit

 

History

History
173 lines (128 loc) · 4.22 KB

readme.md

File metadata and controls

173 lines (128 loc) · 4.22 KB
Raw

Guy Veut

Guy Veut is a slack application that do the same as HeyTaco or Briq, for free 😉

The main goal is to build a strong and happy team.

Tech used

Infra

Code

Prerequisites

You need to have on your machine

  • Node.js (use nvm)
  • Yarn
  • Lerna
  • AWS cli
  • Serverless

For local development:

  • Docker
  • Caddy
  • Ngrok

Installation

Retrieve a Slack App Configuration Token

  1. Generate your App Configuration Token
  2. Export it as an environment variable : export SLACK_APP_CONF_TOKEN=xoxe.xoxp-1-Mi...

Init a Slack app (only once)

  1. Create the slack app - run ./install slack create
  2. Retrieve from output:
    • APP_ID
    • CLIENT_ID
    • CLIENT_SECRET
    • VERIFICATION_TOKEN
    • CLIENT_SIGNING_SECRET
  3. Retrieve your BOT_TOKEN:
    • connect to https://api.slack.com/apps/${app_id}/oauth
    • click Install to Workspace
    • validate
    • Retrieve BOT_TOKEN
  4. Reflect those to this example configuration file - .config.dev.yml (must be placed in the root directory) 
    MAX_POINT_PER_DAY: 5        # Maximum point a user can give per day
REACT_SYMBOL: ""            # Emoticon the bot will use to validate message
REACT_NEGATIVE_SYMBOL: ""   # Emoticon the bot will use to reject message
REWARD_SYMBOL: ""           # Emoticon use to reward someone
REWARD_NAME: ""             # Name of the reward (eq. cookie)
REWARD_PLURAL: ""           # Plural name of the reward (eq. cookies)
CLIENT_ID: ""
CLIENT_SECRET: ""
VERIFICATION_TOKEN: ""
CLIENT_SIGNING_SECRET: ""
BOT_TOKEN: ""
STAGE: "dev"

Deploy the bot

Install dependencies :

yarn

Deploy the serverless stack :

yarn deploy

Configure your slack app (again)

  • Reconfigure you Slack app - run ./install slack update -i ${app_id}

Local development

Retrieve a Slack App Configuration Token

  1. Generate your App Configuration Token
  2. Export it as an environment variable : export SLACK_APP_CONF_TOKEN=xoxe.xoxp-1-Mi...

Init a Slack app (only once)

  1. Create the slack app - run ./install slack create
  2. Retrieve from output:
    • APP_ID
    • CLIENT_ID
    • CLIENT_SECRET
    • VERIFICATION_TOKEN
    • CLIENT_SIGNING_SECRET
  3. Retrieve your BOT_TOKEN:
    • connect to https://api.slack.com/apps/${app_id}/oauth
    • click Install to Workspace
    • validate
    • Retrieve BOT_TOKEN
  4. Reflect those to this example configuration file - .config.dev.yml (must be placed in the root directory) 
    MAX_POINT_PER_DAY: 5        # Maximum point a user can give per day
REACT_SYMBOL: ""            # Emoticon the bot will use to validate message
REACT_NEGATIVE_SYMBOL: ""   # Emoticon the bot will use to reject message
REWARD_SYMBOL: ""           # Emoticon use to reward someone
REWARD_NAME: ""             # Name of the reward (eq. cookie)
REWARD_PLURAL: ""           # Plural name of the reward (eq. cookies)
CLIENT_ID: ""
CLIENT_SECRET: ""
VERIFICATION_TOKEN: ""
CLIENT_SIGNING_SECRET: ""
BOT_TOKEN: ""
STAGE: "dev"

Start prerequisites

ngrok http http://localhost:2000 --host-header="localhost:2000" --verify-webhook slack --verify-webhook-secret ${VERIFICATION_TOKEN}
# Retrieve your ngrok_endpoint
  • Run the Caddy proxy
caddy run --watch

Configure your slack app (again)

  • Reconfigure you Slack app
./install slack update -i ${app_id} --target ${ngrok_endpoint}/dev
# make sure to add /dev at the end

Start the local bot

  • Make sure Docker is running (for dynamodb)
  • Install dependencies :
yarn
  • Deploy the serverless stack :
yarn local

Todo

  • Verify and list permissions needed on slack side
  • Remove unused variables