DVA is a Discord bot that reads google sheets data to verify members on the discord server and assign roles according to their region & Binusian angkatan.
- Create a Google Cloud Project.
- Activate the Google Sheets API and create a service account.
- Make sure this service account has access to the spreadsheet used, share to it using its email as if it were a normal user.
- Create a key credential for this account and download it as a JSON file.
- Encode this file into a base64 string (without newlines).
- Create an application at the discord developer portal
- Clone the repository
- Create a .env file (see example.env) at the repository root
- Install dependencies with (
npm install) - Build (
npm run build) and run (npm start)
- This project uses the Prettier code formatter. Please make sure code is formatted before submitting a pull request.
- discord.js | The Discord client library of choice. Used for both bot gateway and REST API access.
- googleapis | For connecting to Google Sheets.
- zod | For parsing typed structs from unstructured data such as environment variables and data from Sheets.
- immutable-js | For fast immutable data structures.
This project roughly goes by Hexagonal Architecture. In a nutshell, we distinguish between the Driving Side (left side), Core App (middle) and Driven Side (right side).
Discord's Slash Commands are the driving side of this app.
All business logic is contained in "lib". It accesses data from Sheets and makes changes to the Discord server through adapters (the Driven side).
To keep file counts low, implementations are located in the same file as the interfaces, unless there are multiple implementations.
