https://github.com/fireworkweb/bill-mccash-slack-bot
https://github.com/fireworkweb/bill-mccash-slack-bot
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fireworkweb/bill-mccash-slack-bot
- Owner: fireworkweb
- Created: 2016-02-24T21:17:07.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T04:01:00.000Z (over 3 years ago)
- Last Synced: 2024-05-03T03:59:39.058Z (about 2 years ago)
- Language: JavaScript
- Size: 417 KB
- Stars: 2
- Watchers: 7
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bill McCash Slack Bot :moneybag:
Bill is a bot that reports you the current money exchange rate via [Slack](https://slack.com/). Now supports cryptocurrencies :smiley:.
## Dependencies
- Node
- Yarn
**Slack Integrations**
- [Incoming WebHooks](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks)
- [Outgoing WebHooks](https://slack.com/apps/A0F7VRG6Q-outgoing-webhooks)
## Installation
```sh
# install dependencies
yarn install
# build
yarn build
# or
npm run build
```
## Configuration
All of the environment variables are stored in the `src/env-example.js` file. Rename this file to `src/env.js`.
### Cron-style Scheduling
If you wish to schedule automated posts, then you can use the integrated cron scheduler. Add the configuration to the `env.js` file. The cron format consists of:
```
* * * * * *
┬ ┬ ┬ ┬ ┬ ┬
│ │ │ │ │ |
│ │ │ │ │ └ day of week (0 - 7) (0 or 7 is Sun)
│ │ │ │ └───── month (1 - 12)
│ │ │ └────────── day of month (1 - 31)
│ │ └─────────────── hour (0 - 23)
│ └──────────────────── minute (0 - 59)
└───────────────────────── second (0 - 59, OPTIONAL)
```
## Initializing
Run build and start `dist/index.js` file
```sh
# start server
npm start
```
**Enjoy** :smiley:
## Collaborate!
Do you have a question? Found an issue? [Tell us](https://github.com/firework/Bill-McCash-Slack-Bot/issues)!