Skip to content

Citydao Discord bot that syncs Discord roles with Discourse Groups

Notifications You must be signed in to change notification settings

citydaoproject/citydao-discord-bot

Repository files navigation

DiscordBot-DiscourseGroup-SyncBot 👋

Version Documentation Maintenance

An open source discord.js bot which is based on official discord.js guide.

Introduction

This discord bot task is to sync the Discord roles with the discourse form of CityDAO using an event-based architecture.

Features:

In-built useful and flexible features, such as

Event based driven role changes

Jest Discordjs Tesing framework --> WORK IN PROGRESS

Quickstart

Install

npm install

Configuration

Change config.json

{
  "clientId": "<Discord Client ID>",
  "guildId": "<Discord Guild ID>",
  "token": "<Discord Bot ID",
  "Api_Key": "<Discourse API Key>",
  "Api_Username": "<Discourse Name>"
}

Run your bot

npm start

Run test cases

npm test

Author

👤 Earl Potters

👤 Will Jaw

Contributors

👤 Thank you so much to Tuncay 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.

📝 License

Copyright © 2022 Earl Potters.
Copyright © 2022 Will Jaw.
This project is Apache-2.0 licensed.


About

Citydao Discord bot that syncs Discord roles with Discourse Groups

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published