Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prazdevs/zoe-bot-4

🤖 A whimsical bot to automatically post Reddit submissions to Discord, with moderation features.
https://github.com/prazdevs/zoe-bot-4

discord discord-bot nodejs reddit typescript

Last synced: 10 days ago
JSON representation

🤖 A whimsical bot to automatically post Reddit submissions to Discord, with moderation features.

Host: GitHub
URL: https://github.com/prazdevs/zoe-bot-4
Owner: prazdevs
License: mit
Created: 2020-08-19T09:31:54.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2021-07-01T18:14:00.000Z (over 3 years ago)
Last Synced: 2024-10-11T15:46:42.525Z (about 1 month ago)
Topics: discord, discord-bot, nodejs, reddit, typescript
Language: TypeScript
Homepage: https://zoe-bot-docs.vercel.app/
Size: 532 KB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

Artwork by Quiet Hush

Welcome to the Zoe Bot 4 repo 👋

## 🧱 Prerequisites

To run your instance of the bot, you will need:

- a Discord app & bot token. Get it [here](https://discord.com/developers/applications).
- a Reddit app with client id and secret. Get it [here](https://discord.com/developers/applications).
- a Postgres database and its connection URL.

## 🚀 Easy deployment on Heroku

Click on the button:

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/prazdevs/zoe-bot-4)

Note: it will provision a free tier worker dyno and a free tier postgres add-on.

## 🔨 Manual installation

Follow the steps:

1. Install dependencies: `yarn`.
2. Build the solution: `yarn build`.
3. Set up the following environment variables:
- `DISCORD_TOKEN`: your Discord bot token.
- `DATABASE_URL`: your Postgres database connection URL.
- `REDDIT_USERNAME`: the reddit username associated with the app.
- `REDDIT_PASSWORD`: the reddit password associated with the app.
- `REDDIT_APP_ID`: the reddit client id associated with the app.
- `REDDIT_APP_SECRET`: the reddit client secret associated with the app.;
4. Run the application: `yarn start`.

## 🤝 Contributing

Any contribution to the project is welome.
Run into a problem? Open an [issue](https://github.com/prazdevs/zoe-bot-4/issues/new/choose).
Want to add some feature? PRs are welcome!

## 👤 About the author

Feel free to contact me:

-
-

## 📝 Licence