A Discord bot made for Psi Beta Rho. :)
- Install node and yarn.
- Download and copy .env.example as .env
- Run
yarn install
to install dependencies - Either ask me for your own discord bot user OR Create your own discord bot application: https://discordjs.guide/preparations/setting-up-a-bot-application.html
- Invite your discord bot to our shared testing discord server. If you need admin, let me (Alec) know.
- Add the token from step 3 into the .env in the proper location. Make sure there are no extra spaces between the text and the equals sign!
- Replace GUILD_ID with the server id you are testing in, CLIENT_ID with the discord bot user id, and OWNER_ID with your user id (this is used solely for /eval). Getting IDs: https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-
- Before making new changes, do
git checkout -b BRANCHNAME
where BRANCHNAME is a name for whatever feature you are working on.
- As this bot uses some features of GSuite (Google sheets and google forms), running this bot will require obtaining some credentials. You do NOT need a project with billing enabled to do this.
- Follow the instructions here (you can ignore the optional steps): https://cloud.google.com/iam/docs/service-accounts-create
- Once in the service account, go to keys --> add key --> create new key --> JSON, download and save this file as
credentials.json
- Enable the APIs: Go to Google Workspace --> APIs, and enable the
Google Sheets
andGoogle Forms
APIs.
- If this is the first time you are running OR you changed the format of slash commands, refresh them by running
yarn deploy
- Run
yarn start
to run the bot
- Do NOT run multiple copies of a bot under a single bot token, otherwise weird issues may occur!
- Make commits as needed.
git pull origin --rebase
to make sure your code is up-to-date. If this is unsuccessful, you may need to manually resolve conflicts by editing filesyarn fix
to enforce coding formattinggit add . && git commit
the prettier change if any files changedgit push origin BRANCHNAME
to push to remote branch of new name- Open Pull Request in Github website