https://github.com/devcongress/slackbot
A slackbot
https://github.com/devcongress/slackbot
botkit chatbot devcongress nlp slack slackbot
Last synced: 5 months ago
JSON representation
A slackbot
- Host: GitHub
- URL: https://github.com/devcongress/slackbot
- Owner: devcongress
- License: mit
- Created: 2016-08-03T23:48:25.000Z (almost 10 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-04T22:10:43.000Z (over 3 years ago)
- Last Synced: 2024-05-01T23:48:00.500Z (about 2 years ago)
- Topics: botkit, chatbot, devcongress, nlp, slack, slackbot
- Language: JavaScript
- Size: 2.76 MB
- Stars: 30
- Watchers: 6
- Forks: 23
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- Made-in-Ghana - Slackbot (Devcongress) - A slackbot for the DevCongress slack group that greets, tell jokes, announce events **By [@silentworks](https://twitter.com/silentworks) and [@theRealBraZee](https://twitter.com/theRealBraZee)** (<a name="S"> </a>S)
README
# Slackbot
## Introduction
> A simple slackbot for the DevCongress slack, which does tasks including:
- welcome new members
- greet in the morning and night
- forex exchange to GH¢ e.g. `@botname convert 20 euros` or `@botname convert $30`
- forex exchange from one currency to another e.g. `@botname convert 20 eur to gbp`
- Define common English words e.g. `@botname define fire` or `@botname What is the meaning of marketing`
- Get jobs from the DevCongress Jobs Board e.g. (DM the bot) `React jobs` or `Jobs for UI designers` or `Node and Rails jobs`
## Teaching the bot new tricks
- Read the [Contribution Guide](https://github.com/devcongress/slackbot/blob/develop/CONTRIBUTING.md).
- Open your terminal and run `npm run generate`, follow the prompts to scaffold the required files.
- Replace the scaffolded code with your own
- Submit a PR
Find relevant documentation at [Botkit](https://github.com/howdyai/botkit/blob/master/readme.md) and [Slack API](https://api.slack.com/)
## Installation
Clone the repository
> git clone https://github.com/devcongress/slackbot
Go to your terminal and navigate to the directory you cloned the code to and run
```bash
npm install
```
### Run the Bot:
Get a Bot token from Slack:
> http://my.slack.com/services/new/bot
Rename `example.env` to `.env` and update the environment variables in the file.
Run your bot from the command line:
```bash
node index.js
```
The bot is written with botkit which you can learn more about it here [http://howdy.ai/botkit](http://howdy.ai/botkit)
## License
This project is licensed under the MIT license.