kamos1 / handout

A Slack integration for publicly shaming and praising your friends

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Application Name: Handout

CircleCI

Overview:

Handout is a slackbot that I created for my module 3 personal project. It allows users on Slack to jokingly give one another a win or loss for something they have done. The backend is built with Express, Knex, and Postgres. The backend stores the username and the number of wins and losses associated with it. The frontend is built with React. Using the predefined slash commands users can retrieve the number of wins and losses they have. If you would like to test it out for yourself, my username is @keji, the commands are below and the link to join the Slack team is here and the frontend can be accessed here

A quick demo

Slash Commands

give someone a win

  • /give win @username

give someone a loss

  • /give loss @username

check how many wins or losses a user has

  • /check wins @username

  • /check losses @username

Installation and Setup

  • git clone
  • npm install
  • create a new database in the terminal with the following commands
    • psql
    • CREATE DATABASE name of database;
    • \q
  • update knexfile.js
    • under development change connection from postgres://localhost/slack to postgres://localhost/'database you just created'
  • knex migrate:latest
  • knex seed:run
  • npm start
  • mocha (you will need to have mocha globally installed to run this command)

About

A Slack integration for publicly shaming and praising your friends


Languages

Language:JavaScript 100.0%