This bot is built primarily for the Simple Icons Discord server. We wanted a way to show statistics about our primary repository within Discord using voice channels.
- Copy
.env.exampleto.envand populate the values. Details can be found below.
| Variable | Description | Mandatory? |
|---|---|---|
GITHUB_TOKEN |
A GitHub Personal Access Token (PAT) which has permission to read your organisation data. You can create one here | Yes |
REPOSITORY_NAME |
The name of the repository you'd like to monitor, in our example simple-icons. |
Yes |
REPOSITORY_OWNER |
The user/organisation that owns the repository you'd like to monitor. In our case this is also simple-icons. |
Yes |
DISCORD_TOKEN |
The bot token for your Discord bot. | Yes |
UPDATED_AT_CHANNEL |
The ID of the Discord channel you'd like to post the 'last updated' time to. | No |
PRS_CHANNEL |
The ID of the Discord channel you'd like to post the number of open PRs to. | No |
ISSUES_CHANNEL |
The ID of the Discord channel you'd like to post the number of open issues to. | No |
VERIFY_CHANNEL |
The ID of the Discord channel you'd like to point new members to. | No |
UPDATES_CRON |
A CRON code for how often the bot should update its' bio and the channels (if set) | No |
RELEASE_NOTIFICATION_CHANNEL |
The ID of the Discord channel you'd like to send release notifications to. | No |
RELEASE_NOTIFICATION_ROLE |
The ID of the Discord role you'd like to notify of a release. | No |
RELEASE_CRON |
A CRON code for when the bot should check for releases. | No |
TZ_IDENTIFIER |
The timezone identifier for your preferred region. Defaults to Europe/London. |
No |
- Install dependencies with
npm install. - Run the bot with
npm run prod.
If you're testing this locally, you can use the command npm run dev to run nodemon with TypeScript support.
- Add Discussions Channel
- Add Latest Release Channel