ijemmao / task_bot Goto Github PK

View Code? Open in Web Editor NEW

1.0 2.0 0.0 2.29 MB

a slack bot that organizes the dali slack group

JavaScript 100.00%

slack-bot javascript botkit

task_bot's Introduction

DALI Task Bot 🐝

A slack bot focused on increasing lab activity by engaging in general activity in all slack channels.

Setup 🚀

Environment Keys

TASK_BOT_TOKEN - Slack API key used to authenticate the slack bot

TASK_BOT_AUTH - Google Sign in API key to authenticate self

Start the Project

git clone the repository and then run the following commands:

cd task_bot
npm install
npm run dev

You should see the following message telling you have started the project successfully:

Task Bot is up and running!

You will need to have a local instance of MongoDB running in order to handle the data:

In one tab in your terminal run:

mongod

In another tab run:

mongo task_bot

This is the name of the database for this project.

Generation Scripts

There is some data that needs to be present in the database to ensure that future manipulation works. Go to app/scripts to find all the data generation scripts necessary in order to interact with the bot fully.

Commands 💪🏾

There are a list of commands that the task bot will recognize by direct messages - you must be in DM channel for the bot to respond

Add Users

add_user <@slack_id> - POST

Adds the specified slack user into the local database

Example

add_user @ijemmao

Adds the slack user @ijemmao to the local database

add_all_users - POST

Adds all users in the slack team

Get Users

get_all_users - GET

Gets all the users in the local Slack database

get_dali_users - GET

Gets all the users from the DALI API

Channel Activity

poke_channels_activity - POST

Pokes all the channels with low channel activity in the past week. The message is sent out every Saturday at 10AM.

Note: There are two sources that this bot is interacting with:

Local Slack Database - Included in this repo, there is a local database that holds Slack related user information
DALI API - A private API created by @johnlev that stores updated DALI member information

Authors 📝

Ijemma Onwuzulike '19
Sofia Stanescu-Bellu '20

task_bot's People

Contributors

Stargazers

Watchers

Ask to update it's teams list - this is the list it will use to make it's general activity calculations
Ask every 5 weeks or so to remove channels based on some criteria
Channel's member information - which member in each channel is a PM, designer, or developer

Send Milestone Blurb to Developers

Track channel activity

Bot should acculmate general information about a channel's activity:

Comments
Images
Pushes/Commits
Etc.

Set up CircleCI

I'm realizing that there's a ton of testing that needs to be done.