https://github.com/theroughcode/teambot-slackapp
:robot: Team formation bot for hackathons!
https://github.com/theroughcode/teambot-slackapp
Last synced: over 1 year ago
JSON representation
:robot: Team formation bot for hackathons!
- Host: GitHub
- URL: https://github.com/theroughcode/teambot-slackapp
- Owner: theRoughCode
- License: mit
- Created: 2017-08-13T23:23:42.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-10T01:14:16.000Z (over 8 years ago)
- Last Synced: 2025-02-16T22:35:57.375Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 289 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Teambot
Teambot is the revamped Slack version of [MayBot](https://github.com/theRoughCode/maybot). Teambot is a Slack app that hackathons
can use within their hackathon Slack to help hackers get matched based on roles and skills.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
You'll need Node.js and npm (a package manager for JavaScript). You can download Node.js from [here](https://nodejs.org) which includes npm.
### Installing
A step by step series of examples that tell you have to get a development env running
1. Download this repo locally.
2. Install node modules.
```
npm install
```
3. Create a Firebase project and generate your service account credentials.
(More info [here](https://firebase.google.com/docs/admin/setup))
4. Download your service account credentials.
5. Go to your [Firebase project](https://console.firebase.google.com/u/0/) -> Database, copy the URL of your firebase database. (Should be of the form https://{project_id}.firebaseio.com/)
6. Create a new Slack app [here](https://api.slack.com/apps).
7. Create a `.env` file in the main directory of the project and include the following key-value pairs:
i. `PORT` - define the port used for the local server
ii. `API_TOKEN` - token used to connect to your hackathon's Slack.
Create a token [here](https://api.slack.com/custom-integrations/legacy-tokens)
iii. `FIREBASE` - copy and paste the JSON within the Firebase service account credentials you downloaded in step 4.
iv. `BOT_CHANNEL_NAME` - name of channel within your Slack.
v. `RAPH_NAME` - Slack username of bot rep. Any errors will be sent to this user.
vi. `DB_NAME` - name of hackathon
vii. `DB_URL` - Firebase database URL
```
PORT=8000
API_TOKEN=enter_token_here
FIREBASE={"type": "service_account", "project_id": "some_id", "private_key_id": "some_key", "private_key": "-----BEGIN PRIVATE KEY-----\nsome_private_key\n-----END PRIVATE KEY-----\n", "client_email": "some_email", "client_id": "some_client_id", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://accounts.google.com/o/oauth2/token", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "client_x509_cert_url": "some_url"}
BOT_CHANNEL_NAME=looking-for-team
RAPH_NAME=raphael
DB_NAME="Hack the North"
```
## Deployment
### Local Deployment
For local deployment, download [ngrok](https://ngrok.com/).
1. In terminal, run `npm start` or `nodemon` (more info on nodemon [here](https://nodemon.io/)) from the project root directory.
2. `./ngrok http 8000` where `8000` is the port name you defined within your `.env` file.
3. Open `http://localhost:4040` in your browser. This keeps track of the http requests made to your local server and the responses.
4. Copy the webhook given to you by ngrok.
5. In your Slack app dashboard, go to _Settings_ -> _Install App_, and install the app into your Slack.
6. Go to _Features_ -> _Interactive Components_, and input `http://{webhook}.ngrok.io/interact` under _Request URL_.
7. _Features_ -> _Slash Commands_ -> _Create New Command_, and enter the following:
1. Command: `/teambot`
2. Request URL: `http://{webhook}.ngrok.io/slash`
3. Short Description: `Manage team formation`
4. Usage Hint: `[start, help, list]`
8. _Features_ -> _OAuth & Permissions_ -> _Scopes_, add the following scopes:
- commands
- incoming-webhook
- channels:read
- chat:write:bot
- chat:write:user
- groups:read
- im:history
- im:read
- im:write
- users.profile:read
9. _Features_ -> _Event Subscriptions_, turn *Enable Events* on.
10. Input the _Request URL_ as `http://2c20523c.ngrok.io/events`.
11. Subscribe to the `member_joined_channel` and `member_left_channel` events.
12. Type `/teambot` in the bot channel to begin the conversation!
### Live Deployment
1. Host it using a web hosting service like [Heroku](heroku.com)
2. Replace all `ngrok` endpoints in the above steps with your live web URL.
3. Type `/teambot` in the bot channel to begin the conversation!
## Built With
* [JavaScript](https://www.javascript.com/) - The language of choice
* [Node.js](https://nodejs.org) - Our server framework
* [npm](https://www.npmjs.com/) - Package manager
* [Slack API](https://api.slack.com/web) - API to communicate with Slack
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Authors
* **Raphael Koh** - *Initial work and Project Owner* - [TheRoughCode](https://github.com/theRoughCode)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
## Acknowledgments
* [Clayton Halim](https://github.com/clayton-halim) for collaborating with me on [Maybot](https://github.com/theRoughCode/maybot) at FraserHacks!
* The Hack the North team for helping me test the app!