Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vinibgoulart/discord-bot-github-notifications
🤖 Discord bot to see your github notifications
https://github.com/vinibgoulart/discord-bot-github-notifications
discord-bot observability typescript
Last synced: about 2 months ago
JSON representation
🤖 Discord bot to see your github notifications
- Host: GitHub
- URL: https://github.com/vinibgoulart/discord-bot-github-notifications
- Owner: vinibgoulart
- Created: 2023-03-28T21:22:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-03-29T11:26:17.000Z (over 1 year ago)
- Last Synced: 2024-06-12T13:20:07.988Z (4 months ago)
- Topics: discord-bot, observability, typescript
- Language: TypeScript
- Homepage:
- Size: 23.4 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🤖 Discord Bot Github Notifications 🤖
Get your github notifications by a discord bot
Use it in a channel by setting an environment variable with a personal token, or use it privately in your DM
## How To Run
### Requirements
- Have a discord bot with the following Privileged Gateway Intents: PRESENCE INTENT, SERVER MEMBERS INTENT, MESSAGE CONTENT INTENT
- Have a personal access token in Github with the following permissions: notifications
#### Clone this repository, go into and install dependencies
```bash
git clone https://github.com/vinibgoulart/discord-bot-github-notifications
cd discord-bot-github-notifications
yarn
```
#### Create .env based on .env.example variables
```bash
DISCORD_BOT_TOKEN=
DISCORD_CLIENT_ID=
DISCORD_GUILD_ID=
GITHUB_PERSONAL_ACCESS_TOKEN=
```
#### Add the bot in your discord Chanel
- Go to https://discord.com/developers/applications/ > OAuth2 > URL Generator
- Create a **bot** link with `Send Messages` and `Read Messages/View Channels` permissions
- Get generated URL and paste in your browser
#### Deploy the commands
```bash
yarn deploy
```
#### Start the bot
Open a new bash and start the bot
```bash
yarn start
```
## How to use
#### Chanel
Commands in a chanel
- `/notifications`: fetch all github .env account notifications
- `/ping`: just a ping 🙂
#### DM
Commands in a private
- `/notifications`: send your personal access token and to fetch your notifications