Categorygithub.com/MathisBurger/dom-toretto
module
0.0.0-20240421203006-15ee7dfc43b9
Repository: https://github.com/mathisburger/dom-toretto.git
Documentation: pkg.go.dev

# README

Dom Toretto


Nothing over family!


Project information

This project is just made for fun. Because at the moment (21.07.2021) there are so many memes out, about dom toretto. I had the idea to create a discord bot, that responds to every message that contains a version of the word "family". The response is a random sentence from these memes.

Invite dom to your discord (public instance)

If you want to have dom on your server, you can invite him trough this link: Invitation
NOTE: Because the public instance is maybe used by many people, it could be a bit slow. I am going to improve the performance of dom toretto from time to time.

Setup

There are two different ways, you can setup the project. I recommend setting it up with docker, because this is the easier and faster way, if you already have docker running on your device.

Docker Setup

  1. First pull the docker image from the github-package-registry.
docker pull ghcr.io/mathisburger/dom-toretto:latest
  1. After that you just have to start the container, based on the image you downloaded a few seconds ago.
docker run -d -e botToken=<botToken> ghcr.io/mathisburger/dom-toretto:latest

Consider replacing the botToken with your own bot token.

Compile it yourself

Compiling dom-toretto yourself is a bit more complicated. First your environment must match following requirements.

  • golang 15 or higher
  • Linux (recommended, but not needed)
  • git
  1. clone the code from this repository
git clone https://github.com/MathisBurger/dom-toretto.git
  1. go into the directory, you cloned.
cd dom-toretto
  1. Compile the executable
go build -o ./dom-toretto ./cmd/dom.go
  1. Make the file executable (Linux)
chmod +x ./dom-toretto
  1. set the environment variables (not working on Windows. You need to use the GUI)
export mode=prod
export botToken=<botToken>

Consider replacing the botToken with your own bot token.

  1. start the bot
sudo ./dom-toretto

NOTE: if you are using windows, just execute the file with administrator privileges

Contributing

If you want to contribute to the project, take a look into the CONTRIBUTING.md.
If you just want to add new synonyms for family, or a new sentence, open a new issue and fill out the template for new synonyms.
If you want to request a new feature, just create a new issue and fill out the template for a feature request.

# Packages

No description provided by the author