https://github.com/michaelhillcox/buildingbot

Discord bot for DW Building Gadgets issue linking and other misc tasks.
https://github.com/michaelhillcox/buildingbot

buildinggadgets discord-bot discordjs nodejs typescript

Last synced: about 1 month ago
JSON representation

Discord bot for DW Building Gadgets issue linking and other misc tasks.

• Host: GitHub
• URL: https://github.com/michaelhillcox/buildingbot
• Owner: MichaelHillcox
• License: mit
• Created: 2019-02-04T10:05:44.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2023-02-11T16:04:26.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T15:35:37.157Z (7 months ago)
• Topics: buildinggadgets, discord-bot, discordjs, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 664 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BuildingBot

Building Bot is a simple discord bot created using Typescript and NodeJS to enable basic level intergration between our Github Repo and our Discord Server. This is a specific use discord bot meaning that it'll likely not fit your use-cases but it can be used as a good example on how to work with the Github, Discord, and Curse API (poorly).

## How to use

So you still want to use it? Wow, okay, heres the basic low down on what to do.

- Go to [Discord](discord.com), find the developers tab and create yourself a bot.

- Generate / reveal your token, note this down

- Copy the `config.example.toml` and paste it as `config.toml`

- Edit the `config.toml` file to include your github repo owner, repo name and your discord token.

- Run `npm install` (You'll need node installed)

- Finally: 

    - run `npm run dev` for testing / development

    - or `npm run build` to build the project for deployment.

## Todo: 

- [ ] Expand on the curse support

- [ ] Support github releases

## License

[MIT](LICENSE)