prazdevs / zoe-bot-4

πŸ€– A whimsical bot to automatically post Reddit submissions to Discord, with moderation features.

Home Page:https://zoe-bot-docs.vercel.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.
  • a Reddit app with client id and secret. Get it here.
  • a Postgres database and its connection URL.

πŸš€ Easy deployment on Heroku

Click on the button:

Deploy

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.
Want to add some feature? PRs are welcome!

πŸ‘€ About the author

Feel free to contact me:

πŸ“ Licence

Copyright Β© 2020 Sacha Bouillez.
This project is under MIT license.

About

πŸ€– A whimsical bot to automatically post Reddit submissions to Discord, with moderation features.

https://zoe-bot-docs.vercel.app/

License:MIT License


Languages

Language:TypeScript 99.6%Language:Shell 0.4%