The official discord bot for Garbage Collectors Discord. This bot facilitates discussion and Q/A in our programming channels.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
- Dotnet Core 2.2
- MySql Server
- (Optional) Dotnet CLI
Start by cloning this repository.
git clone https://github.com/garbage-collectors-development/GCBot.git
Then setup you environment variables, such as your discord bot token or database strings. These can be set in the terminal or in your run configuration if using Visual Studio or Rider/IntelliJ.
export TOKEN="{your_token}"
export CONNECTIONSTRINGS_DATABASE="{database_conn_string}"
export ENVIRONMENT="Development"
if you prefer to store your token using the secrets tool (which stores the token in a secure file)
dotnet user-secrets set "TOKEN" "{your_token"} --project "GCBot.Container"
These environment variables will override any configuration settings specified in the appsettings files.
The precedence of config settings goes from lowest to highest:
- appsettings.json
- appsettings.Production.json | appsettings.Development.json
- environment variables
- user-secrets
When deploying, make sure to set your environment variable for ENVIRONMENT="Production".
- Discord.NET - .NET wrapper for Discord API
- NuGet - Dependency Management
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Julian - Project Creator, Backup Reporting - caveofjulian
- Jeremy Guinn - Configuration, Attachment Management - JeremyGuinn
See also the list of contributors who participated in this project.
This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details
- Starwalker#0495 for assisting in project architecture