mdiluz/matchy
mdiluz/matchy
1
0
Fork 0
Code Issues 5 Pull requests 8 Packages 1 Activity Actions

Use forgejo registry for the image
All checks were successful
Test, Build and Publish / test (push) Successful in 34s
Details
Test, Build and Publish / build-and-push-images (push) Successful in 1m10s
Details

Browse source
This commit is contained in:
Marc Di Luzio 2024-08-25 21:16:25 +01:00
parent 25cb5b9dba
commit 7afa5086fd
3 changed files with 8 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -7,8 +7,6 @@ Matchy is a Discord bot that groups up users for fun and vibes. Matchy can be in
Note: Matchy currently only allows owner-authorised users to trigger posts in channels.
![Tests](https://github.com/mdiluz/matchy/actions/workflows/test.yml/badge.svg)
## Commands
Matchy supports a bunch of user, `matcher` and bot owner commands. `/` commands are available in any channel the bot has access to, and `$` commands are only available in DMs.
@ -35,7 +33,7 @@ Development has been on on Linux so far, but running on Mac or Windows _should_
### Getting Started
```bash
git clone git@github.com:mdiluz/matchy.git
git clone https://forge.mdiluz.io/mdiluz/matchy.git
cd matchy
python -m venv .venv
source .venv/bin/activate
@ -56,11 +54,11 @@ State is stored locally in a `.matchy/state.json` file. This will be created by
The `TOKEN` envar is required run the bot. It's recommended this is placed in a local `.env` file. To generate bot token for development see [this discord.py guide](https://discordpy.readthedocs.io/en/stable/discord.html).
### Docker
Docker and Compose configs are provided, with the latest release tagged as `ghcr.io/mdiluz/matchy:latest`. A location for persistent data is stil required so some persistent volume will need to be mapped into the container as `/usr/share/app/.matchy`.
Docker and Compose configs are provided, with the latest release tagged as `forge.mdiluz.io/mdiluz/matchy:latest`. A location for persistent data is stil required so some persistent volume will need to be mapped into the container as `/usr/share/app/.matchy`.
An example for how to do this may look like this:
```bash
docker run -v --env-file=.env ./.matchy:/usr/src/app/.matchy ghcr.io/mdiluz/matchy:latest
docker run -v --env-file=.env ./.matchy:/usr/src/app/.matchy forge.mdiluz.io/mdiluz/matchy:latest
```
A [`docker-compose.yml`](docker-compose.yml) file is also provided that essentially performs the above when used with `docker compose up --exit-code-from matchy`. A `MATCHY_DATA` envar can be used in conjunction with compose to set a custom local path for the location of the data file.