Slyracoon23 / DiscordBot-Discourse-deprecated

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Discord-discourse role sync 👋

Version Documentation Maintenance Twitter: namanvrati

An open source discord.js bot template which is based on official discord.js guide to get started on making your very personal discord bot!

🏠 Homepage

Introduction

CityDAO will sync roles between discord and discourse using the bot applaction side to do REST API request to discoures APIs.

Features:

This in-built useful and flexible features, such as

Event based driven role changes:

  • All events for role changes will be handled by the handle manager.
  • handle manager will update and relfect the changes to discourse.
  • Master-slave roles will be Discord to Discourse

Account creation and linking

  • Accouts will have to link their discord on CityDAOs discourse form. After that they will be able to have role syncing capabilities.
  • Reminder for people to connect with Discord on discourse form.

List roles command

  • Ask the bot to list your current roles on discourse and discord

Manual Discord manual Role adding

Possible feature

Install

npm install

Configuration

  • Rename config-example.json to config.json and fill the token and other values. Extend config.json according to your needs!

Run your bot

npm start

Support & Documentation

I'm working to make it more professional and easy to use for everyone. There will be a documentation out very soon.

WIP : https://djs.docs.namanvrati.cf/

Author

👤 Naman Vrati

Contributors

👤 Thank you so much to Krish Garg and Thomas Fournier for giving awesome contributions to the project.

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you! Star-ring the project gives me encouragement to continue it. You can also sponsor the project and get listed as a contributer! Thanks a lot.

📝 License

Copyright © 2021 Naman Vrati.
This project is Apache-2.0 licensed.


About

License:Apache License 2.0


Languages

Language:JavaScript 100.0%