Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drewolson/epicbot
A Slack Bot for Epic Card Game
https://github.com/drewolson/epicbot
purescript slack-bot slackbot
Last synced: about 2 months ago
JSON representation
A Slack Bot for Epic Card Game
- Host: GitHub
- URL: https://github.com/drewolson/epicbot
- Owner: drewolson
- Created: 2020-01-31T14:58:09.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-05T00:03:52.000Z (almost 2 years ago)
- Last Synced: 2024-05-09T21:50:09.240Z (8 months ago)
- Topics: purescript, slack-bot, slackbot
- Language: PureScript
- Size: 285 KB
- Stars: 12
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Epicbot
[](https://github.com/drewolson/epicbot/actions/workflows/test.yml)
Epicbot is a slack bot written in [PureScript](http://www.purescript.org/). It
allows you to search for cards from the [Epic Card
Game](https://www.epiccardgame.com/) and display the results in your slack
channel.
To search for a card, simply type some or all of its name. Epicbot will perform
a full text search to find the correct card.
```text
/epic
```
You can also generate an example random dark draft draw using the `draft`
command.
```text
/epic draft
```
## Deploying
### Install Dependencies
```text
npm install .
```
### Create a Self-Contained JavaScript Bundle
```text
npm run bundle
```
Running this command results in the file `dist/bundle/index.js` being created.
It includes all dependencies required for running the slack bot and can be run
directly with `node`. You'll need to provide your Slack signing secret as an
environment variable.
```bash
SLACK_SIGNING_SECRET= node dist/bundle/index.js
```
Once you have your bot running, you'll want to follow the guide for creating a
[slash command](https://api.slack.com/interactivity/slash-commands) to use the
bot. We recommend using `/epic` as your slash command.
## Contributing
### Install Tool Chain
```text
npm install -g purescript spago
npm install .
```
### Test
```text
spago test
```
### Run
```text
spago run
```
### Format
```text
npm run format:check
```
```text
npm run format
```
### Lint
```text
npm run lint
```
### Run All CI Checks
```text
npm run ci
```