🤖 Water-Heater

· Report Bug · Request Feature ·

About The Project

A api and discord bot for Good Games Munich.

Non technical documentation

See docs.

Setup

Production

1. Follow Discord app getting started and retrieve a bot token
2. Follow Creating a release.

Development

1. Follow Discord app getting started and retrieve a bot token
2. Create a Testing Server in Discord and get the guild id. Follow Guild id location to get the guild id.
3. Follow local setup.
4. Follow the Customization section and set all variables with Required in dev true.
5. Invite your Bot to your Discord server.

Customization

Create a environment file touch .env. Override variables in the {variable name}={variable value} format. All required variables need to be overridden for the respected environment.

Variable	Description	Required in dev	Required in prod	Default value
POSTGRES_PASSWORD	Postgres password. Choose a secure one.	true	true	none
DISCORD_DEVELOPMENT_GUILD_ID	Guild id of a server to test on.	true	false	none

Contributing

Follow contributing.