polpetta
/
mezzotre
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity
Mezzotre is a Telegram bot for helping you manage your DnD content https://mezzotre.poldebra.me
8 Commits
2 Branches
0 Tags
494 KiB
Java 99.8%
Dockerfile 0.2%
 
 
Go to file
Davide Polonio c34d3acabc
continuous-integration/drone/push Build is passing Details
chore: add -B flag to mvnw 		2023-03-27 10:25:22 +02:00
.mvn/wrapper feat: use mvnw, add DroneCI 2023-03-26 22:47:54 +02:00
.run chore: first commit 2023-03-21 18:09:06 +01:00
conf chore: first commit 2023-03-21 18:09:06 +01:00
schema/json chore: first commit 2023-03-21 18:09:06 +01:00
src chore: fix localization tests, add annotations 2023-03-26 22:29:05 +02:00
.drone.yml chore: add -B flag to mvnw 2023-03-27 10:25:22 +02:00
.gitignore chore: first commit 2023-03-21 18:09:06 +01:00
Dockerfile feat: use mvnw, add DroneCI 2023-03-26 22:47:54 +02:00
LICENSE chore: add README 2023-03-26 21:39:02 +02:00
README.md feat: use mvnw, add DroneCI 2023-03-26 22:47:54 +02:00
docker-compose.yml chore: first commit 2023-03-21 18:09:06 +01:00
mvnw feat: use mvnw, add DroneCI 2023-03-26 22:47:54 +02:00
mvnw.cmd feat: use mvnw, add DroneCI 2023-03-26 22:47:54 +02:00
pom.xml chore: fix localization tests, add annotations 2023-03-26 22:29:05 +02:00

README.md

Mezzotre

Build Status

Mezzotre is a DnD content management system. Currently, it is still in the first development stages and everything is still evolving, goals included.

The whole system is based on Java17+ for the language, incoming Webhooks from Telegram, Jooby backend to handle the requests, PostgresSQL to store data and long-term chat context information.

Shipping and running

Keep in mind that Mezzotre is meant to be run behind a reverse proxy handling all the TLS stuff. In the root of the project you can find a docker-compose.yml file that can be a useful starting point to generate your configuration. Finally, you can use the same docker-compose definition as a developer to have a live version running. Simply run:

DEBUG_OPTS=debug- docker-compose up -d --build && docker-compose logs -f

to run a debug instance. Omit the DEBUG_OPTS env variable for a "production" style environment. Note that this configuration requires an .env file (that is not committed for obvious reasons) containing the database password and a valid Telegram Bot token.

To configure Webhook configuration for your bot, open up a terminal and type:

curl -F "url=https://example.com/api/tg" https://api.telegram.org/bot<YOUR BOT TOKEN>/setWebhook

Building

Build is achieved through Maven. To build a jar run:

mvn package -DskipTests=true -Dmaven.test.skip=true -Dmaven.site.skip=true -Dmaven.javadoc.skip=true

In the target/ folder wou will find an uber-jar and optionally the possibility to run it via a script and to setup auto-startup via systemd or openrc units.

Developing

Automatic testing

You can simply run tests with mvn test. This will run UT and IT tests together.

Manual testing

For a manual approach, just open a terminal and type mvn jooby:run. Assuming you have a database locally available (check out application.conf) and a valid Telegram token set (maybe as enviroment variable) you can develop and see live changes of your Mezzotre on the fly. Finally, by using Postman, you can simulate incoming Telegram events.

License

This software is under AGPL3+. You can find all details in the LICENSE file.