https://github.com/sparkbox/project-bot

https://github.com/sparkbox/project-bot

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sparkbox/project-bot
• Owner: sparkbox
• License: mit
• Created: 2019-05-01T19:20:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T01:29:39.000Z (almost 2 years ago)
• Last Synced: 2024-04-11T03:37:35.488Z (9 months ago)
• Language: JavaScript
• Size: 2.1 MB
• Stars: 2
• Watchers: 19
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: readme.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# SlackBot Project

**Team**: Project Manager, Technical Lead, 2 developer apprentices

## Mission:

The goal of this project is to provide Slack Users with information about a current

project. With a slash command, the bot will return requested information such as a

general overview or team information. Specific users will also be able to add and

delete specific information. See the image below to get a better understanding.

## End Goal

![Project Bot End Result](Images/slash.png)

### Knex Configuration:

In order for your Knex migrations to function correctly be sure to setup your

local project `.env` file with your own personal host, user, password and database name

information. Your `.env` file should be private and ignored in your `.gitignore` file.

Copy `envFileExample.txt` to your `.env` file and update with your settings.

## Technologies:

NodeJS, Botkit, MySQL

## Testing:

We are using Botkit Mock to do integration testing and Mocha/Chai for our unit tests.

To run tests: `npm test`