https://github.com/hetic-mt-p2021/project_final_group01_back
🤖 Dimo, a perfect game for you if you're looking to develop a sense of repair and improve your memory. Play WordChain game on Discord with Dimo
https://github.com/hetic-mt-p2021/project_final_group01_back
bot dimo dimo-bot discord game golang wordchain
Last synced: about 2 months ago
JSON representation
🤖 Dimo, a perfect game for you if you're looking to develop a sense of repair and improve your memory. Play WordChain game on Discord with Dimo
- Host: GitHub
- URL: https://github.com/hetic-mt-p2021/project_final_group01_back
- Owner: HETIC-MT-P2021
- License: mit
- Created: 2021-08-30T09:56:27.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-12-06T14:25:20.000Z (over 4 years ago)
- Last Synced: 2025-09-01T20:50:08.540Z (10 months ago)
- Topics: bot, dimo, dimo-bot, discord, game, golang, wordchain
- Language: Go
- Homepage:
- Size: 4 MB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 🤖 Dimo
Dimo is a bot programmed in Go that allows you to play a word game chain on the Discord platform.
It's the perfect game for you if you're looking to develop a sense of repair and improve your memory.
## 🛠 Perequisities
To run this project
- Make sure you have Docker installed on your machine
## 📥 Installation
Want to add some magic code or cool features ✨ to the bot ? Bring the repository down to your local machine by following theses steps
- Clone this repository:
```bash
https://github.com/HETIC-MT-P2021/PROJECT_FINAL_GROUP01_BACK
cd PROJECT_FINAL_GROUP01_BACK
```
- Make sure you have an `.env` file that is matching the example
- Start application by typing
```bash
docker-compose up --build
```
## 🎨 Libraries
There are some external libraries used to build up this magnificent bot 🎖
[discordgo](https://gowalker.org/github.com/bwmarrin/discordgo)
## 🎯 Features
- A bot that manages the game and plays the role of referee 👮
- Multiplayer mode with friends on a server 🎎
- Countdown timer for each round of the game ⌛
A web interface exists allowing ( accessible from the [repo](https://github.com/HETIC-MT-P2021/PROJECT_FINAL_GROUP01_FRONT)) :
- To have access to the statistics of the longest game ever played / or statistics of the last game played 📈
- To follow a game as a spectator 🍿
## 🥋 Contributing
Before contributing, please read the [contributing guidelines](https://github.com/HETIC-MT-P2021/PROJECT_FINAL_GROUP01_BACK/blob/main/COMMIT_CONVENTIONS.md)
## 👨💻 Development mode
1. Most of the time a ticket is assigned ,on the project board, to a team member. If it is not the case and you are told to do it yourself, assign the github ticket to you.
2. When you start working on the ticket, move the concerned ticket to `In Progress`.
3. Create a branch specifically for this ticket with a name that follows the [conventions specified below](#branch-naming-convention).
4. Commit regularly at each significant step with unambiguous commit messages (see [COMMIT_CONVENTIONS](COMMIT_CONVENTIONS.md) file).
5. Create a merge request that follows the [conventions specified below](#pull-requests-pr) to the develop branch.
6. On the project board, move the ticket to the status `In Review`
7. Request a review from another team member.
8. It may take some back and forth before your pull request is validated
9. Your pull request will then be merged into the develop branch and the concerned ticket will be moved to `Done`
## ❓ Any Questions
If you have any questions, feel free to open an issue. Please check the open issues before submitting a new one 😉
### 🛠 Continuous Integration (CI)
A CI pipeline is configured for this project.
The pipeline will run 3 different jobs:
- Dependencies check
- Linter
- Build
## 🏄♂️ Authors
Meriem MRABENT
Jean-Jacques AKAKPO
Fayçal TOURÉ
Alexis Cauchois