Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fc5570/topgg-vote-receiver
A top.gg vote receiver which listens to votes on a bot.
https://github.com/fc5570/topgg-vote-receiver
Last synced: about 2 months ago
JSON representation
A top.gg vote receiver which listens to votes on a bot.
- Host: GitHub
- URL: https://github.com/fc5570/topgg-vote-receiver
- Owner: FC5570
- License: mit
- Created: 2021-07-09T04:26:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-14T07:16:50.000Z (about 2 years ago)
- Last Synced: 2024-10-05T07:12:53.048Z (3 months ago)
- Language: JavaScript
- Size: 41 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# topgg-vote-receiver
A top.gg vote receiver which listens to votes for a bot.
## Example
```js
const VoteListener = require('topgg-vote-receiver');
const vote = new VoteListener({
auth: 'topggauth123',
port: 3000,
});
vote.handleVotes();
vote.on('voted', (vote) => {
console.log(vote);
});
console.log(`Listening on 3000`);
```
## Events
1. 'voted' _(vote)_ - Emitted when a user votes for the bot. `vote` is an object which contains info of the user who voted and other details.
## API
### VoteListener.constructor(options)
`options` is an object which should contain the `auth` and the `port`:
1. **auth** (string): The webhook authorization token for the top.gg webhook. Can be found at the `Webhooks` page of the edit bot page.
2. **port** (number): The port to listen on for the express app.
### VoteListener.handleVotes()
This will start the webhook server.
## Your webhook dashboard should look something like this (if using the example above):
