https://github.com/giveth/giveth-bot
Giveth matrix community bot
https://github.com/giveth/giveth-bot
Last synced: about 1 year ago
JSON representation
Giveth matrix community bot
- Host: GitHub
- URL: https://github.com/giveth/giveth-bot
- Owner: Giveth
- License: gpl-3.0
- Archived: true
- Created: 2018-05-22T08:20:09.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-14T15:52:45.000Z (about 2 years ago)
- Last Synced: 2025-02-22T22:23:53.125Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 129 KB
- Stars: 10
- Watchers: 12
- Forks: 11
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Giveth bot
A matrix bot that handles everything from information to point dishing for the Giveth community.
## Development
1. Follow [this](https://developers.google.com/sheets/api/quickstart/nodejs) guide to get `client_secret.json`.
2. install dependencies: `npm install`
3. Create a matrix account using [riot.im](https://riot.im/app/)
4. Create a `bot_credentials.json` file containing the username and password of the bot in JSON format. Should look something like:
```json
{
"username": "name",
"password": "password"
}
```
5. Simply start the bot using: `node index`
## Production
The bot is automatically deployed to Digital Ocean using Circle CI.
`client_secret.json`, `bot_credentials.json` and `credentials.json` are required files.
## Usage
Invite your bot to a room and use one of the folowing commands:
* `!dish [# of points] [type of points] points to [handle] for [reason explaining why].`
* `!help` for more information.
* `!sheet` to see the current [rewardDAO](https://medium.com/giveth/how-rewarddao-works-aka-what-are-points-7388f70269a) sheet
Pull requests are welcome!
Please run `npm test` before submitting a PR to ensure that you have not introduced any errors.