DinGo

README

DinGo

DinGo is a Discord chat bot intended to provide various useful features.

Overview

• Usage
• Installation
  • Configuration
  • Execution
  • Inline
  • Binary
• License

Usage

This project assumes that Go is both installed, and added to your system's PATH.

Installation

Configuration

Firstly, it is necessary to update the environment file.

$ cp .env_sample .env

After copying over the .env sample file, set the values accordingly.

Execution

There are two methods of running the bot, Docker (Recommended) or Binary. Utilizing the docker method is recommended, as the docker-compose will automatically create a self-hosted MariaDB instance.

Docker

When using this method, be sure to set the following values within .env:

...
PSQL_HOST=127.0.0.1
...

Build image and run as daemon:

$ docker compose up -d

If any changes are made to the environment file, the docker compose will need to be stopped, rebuilt, and started again:

$ docker compose down
$ docker compose build
$ docker compose up -d

Manual

There are two methods of running the project.

1. Inline - Useful for debugging:

   $ go run main.go`
   

2. Binary - Recommended for faster execution times:

   $ go build main.go
   $ ./main.go
   

This will result in a main executable file being created, with the filetype dependent upon the system which the executable was generated.

License

As of 18-Jan-2022, DinGo is fully open to the public, licensed under GPLv2.