https://github.com/the-programmers-hangout/tph-docs-bot

https://github.com/the-programmers-hangout/tph-docs-bot

Last synced: about 14 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/the-programmers-hangout/tph-docs-bot
• Owner: the-programmers-hangout
• License: mit
• Created: 2021-01-07T02:29:37.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-03-02T21:21:10.000Z (over 2 years ago)
• Last Synced: 2023-03-07T05:53:07.680Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 876 KB
• Stars: 3
• Watchers: 5
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tphdocsbot

A Discord bot to display documentation

## Currently supported docs

* discord.js (includes main/stable branch, includes djs-voice, djs-builders and djs-collection documentations)

* Javascript ([mdn](https://developer.mozilla.org/))

## Docker

To build and run the Docker container locally:

```console

docker build . -t tphdocsbot:latest

```

```console

docker run -e TOKEN= -e APPLICATIONID= -e GUILDID= tphdocsbot:latest

```

### Cofiguration

* `TOKEN` [required] the Discord bot token to run under

* `APPLICATIONID` [required]  the Discord bot's application ID. Get it from [Dev portal](https://discord.com/developers/applications) -> your bot -> General Information -> Application ID

* `GUILDID` (required to register on a specific guild) the guild id to register commands on, recommended to register on a specific guild for testing

### Registering

In order to register the commands globally, run

```console

npm run register-global-commands

```

For registering guild-specific commands (Recommended for testing)

```console

npm run register-guild-commands

```

Afterwards to reset guild commands, (To avoid duplication of global and guild-specific commands)

```console

npm run reset-guild-commands

```