Helsinki University software production project, fall 2021
This project implements a discord bot. Bot´s function is to aid students to find the right course channels in discord, where they can ask for help and communicate with other students. For faculty it provides tools to control course information and other features.
Clone repository to your computer.
Install all dependencies npm install.
Add .env file to root of the repository (same directory with package.json).
Add following contents to .env file:
PREFIX=!
DISCORD_BOT_TOKEN=your-own-token
GUILD_ID=your-discord-server-id
BOT_ID=id-of-your-bot
CLIENT_SECRET=your-client-secret
DISCORD_REDIRECT_URL=your-client-oauth2-redirect-url-with-identyfy-guilds.join
DISCORD_SERVER_INVITE=your-discord-server-invite
PORT=your-custom-backend-port
SESSION_SECRET=server-session-secret
BACKEND_SERVER_URL=backend-server-url-without-port
POSTGRES_USERNAME=your-postgres-username (postgres if not changed)
POSTGRES_PASSWORD=your-postgres-password
DB_HOST= (only if you are not using PostgreSQL locally)
GRAFANA_TOKEN=your-grafana-authorization-token
# Bridge
TELEGRAM_BOT_TOKEN=telegram-bridge-bot-token
TG_BRIDGE_ENABLED=true
Setup config.json file:
courseAdminRole: course-admin-role-name
facultyRole: teacher-role-name
Make your own Discord Server. You can find instructions here.
Make your own Discord Bot. You can find instructions here.
Download and install PostgreSQL here.
More help for PostgreSQL (in Finnish) here.
Setting up the backend here.
Run one of the following commands to start bot:
npm run dev (for development vesion)
npm start (for staging version)
npm run test (run all the tests)