Replace Makefile with brewkit, replace .env file with config in docker-compose, add instructions in README

This commit is contained in:
2025-04-26 11:29:51 +03:00
parent 4c205b528f
commit c9b3cf9157
12 changed files with 185 additions and 15 deletions
+49
View File
@@ -1,3 +1,52 @@
# anon3anon
Telegram bot for anonymous messages 🎭✨
## Building for local development
Prerequisites:
1. git
2. docker
Firstly, clone the repository:
```shell
git clone git@github.com:nightnoryu/anon3anon.git
```
Then build the binary:
```shell
./bin/a3abrewkit build
```
This script will download a [brewkit](https://github.com/ispringtech/brewkit) binary and put it in the `bin` directory of the project.
After that, copy the `docker-compose.override.example.yml` to `docker-compose.override.yml` and set the environment variables:
```yaml
services:
anon3anon:
environment:
TELEGRAM_BOT_TOKEN: 123:ABC # The token for your bot, obtained from t.me/BotFather
OWNER_CHAT_ID: 123 # ID of your chat with your bot
```
And you're set! Lastly, run the app:
```shell
./bin/a3acompose up -d
```
While making changes to the app, don't forget to restart the container:
```shell
docker restart anon3anon
```
When you're finished working on the project, bring it down using this command:
```shell
./bin/a3acompose down
```