Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remix-run/remix-discord-bot
https://github.com/remix-run/remix-discord-bot
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/remix-run/remix-discord-bot
- Owner: remix-run
- Created: 2022-06-23T14:44:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-19T13:50:05.000Z (about 2 years ago)
- Last Synced: 2024-09-29T00:20:20.872Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 1.07 MB
- Stars: 40
- Watchers: 6
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-remix - This is the Remix Discord Bot. It's hosted on fly
- awesome-remix - This is the Remix Discord Bot. It's hosted on fly
README
# Remix Discord Bot
This is the Remix Discord Bot. It's hosted on fly. It runs alongside an actual Remix app (Indie Stack) which we may use to have some kind of UI for controlling the bot and stuff. Who knows. It was just nice to do this so we'll have a persistence layer if we decide we need that.
## Development
If you're going to be doing much with the bot, I **strongly advise** you take just 10 minutes to setup your own test bot and server for local development.
You'll need to create your own discord server for local development and manual testing (automated testing of Discord bots is extremely difficult and basically not worth it). You'll also need to create your own bot. It should take ~10 minutes max. Create a [discord server](https://support.discord.com/hc/en-us/articles/204849977-How-do-I-create-a-server-), then follow [the instructions here](https://discordjs.guide/preparations/setting-up-a-bot-application.html) to create a bot application and [add it to your server](https://discordjs.guide/preparations/adding-your-bot-to-servers.html).
Once you have that, then copy the `.env.example` to `.env` and put in values for everything (you'll need to create channels for several of them).
Next run:
```
node ./other/deploy-commands.js
```
That will configure your server to have the slash-commands our bot expects.
Next, run:
```
node ./other/deploy-emoji.js
```
This will update your server with all the emoji reactions the bot has.
Next, run:
```
cp ./bot/src/playground.example.ts ./bot/src/playground.ts
```
That has things setup for you to play around to make the bot do whatever you'd like. Once you're ready to commit to something then stick it in the appropriate file in the `bot/src` directory.
If you'd like, you can make your `playground.ts` file (which is gitignored) have this for its contents:
```js
import ".";
```
And now it'll just do what the actual bot code does. However you want to develop is fine.
To run the playground file, run:
```
npm run play:bot
```
This will start the playground file in watch mode. Any change you make will trigger it to be re-run which should make development pretty quick despite no automated tests.
If you'd like to run the bot and the Remix app together, run `npm run dev`.