Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/upcraftlp/qcc-ews
A Discord Bot that acts as an Early Warning System for the Quilt Community Collab
https://github.com/upcraftlp/qcc-ews
Last synced: 4 days ago
JSON representation
A Discord Bot that acts as an Early Warning System for the Quilt Community Collab
- Host: GitHub
- URL: https://github.com/upcraftlp/qcc-ews
- Owner: UpcraftLP
- License: mit
- Created: 2023-01-29T22:05:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-16T05:35:42.000Z (over 1 year ago)
- Last Synced: 2024-10-11T09:58:40.024Z (28 days ago)
- Language: TypeScript
- Homepage:
- Size: 137 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Quilt Community Collab EWS
A Discord Bot that acts as an Early Warning System for the Quilt Community Collab
## How to use:
For convenience, this application is packaged as a Docker image.
The bot can be configured using [environment variables](.env.example)
```sh
$ docker pull ghcr.io/upcraftlp/qcc-ews:main
```
## Contributing:
1. Install [Yarn](https://classic.yarnpkg.com/en/docs/install "Yarn package manager")
2. Clone the repository
```sh
$ git clone https://github.com/upcraftlp/qcc-ews.git
$ cd qcc-ews
```
3. Install dependencies
```sh
$ yarn
```
4. On the [Discord developer dashboard](https://discord.com/developers/applications "Discord Developer Portal") create a new application and enable the bot user for it
❗Make sure to enable the `SERVER MEMBERS INTENT` toggle in the settings❗
6. To invite the bot to your server, you need to open the invite link in your browser:
*replace `YOUR_CLIENT_ID` with the application ID from the dashboard*
```
https://discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID&permissions=0&scope=bot
```
7. Set up the environment (see [the example file](.env.example))
8. Run the bot in development mode
```sh
$ yarn dev
```