diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..fbb2c7195c9e119189363b74ca1baf4e7398a731 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +<div align="center"> + <img src="./logo.png"> + <h2 align="center">S3rius bot</h2> +</div> + + +This bot listens for all incoming messages and replying +from your account. + +You can define patterns to react on, +such as incoming messages that match some patterns, +new members in groups and much more! + +## Why do I ever need this? + +I don't need it. But sometimes this can become handy. +Some functions I use like every day. +Especially ".pip" ".aur" and ".bl". + +## How can i setup this for my account? +This is pretty simple. +You can run it locally or setup a deployment on your server. + +### Local configuration +To run this locally just clone the repo, +go to the cloned folder and run: +```shell +pip install -r requirements/requirements.base.txt +export $(cat .env) +python main.py +``` +That's all. + +### Server configuration +Clone this repo to your gitlab. +* Change `container_name` in [docker-compose.yml](./docker-compose.yml) and [docker-compose.test.yml](./docker-compose.test.yml). +* Change name of file [bot_s3rius_san.service](./systemd/bot_s3rius_san.service) in systemd folder. +* Update CI variables in Gitlab. + - APP_DIR + - TELEGRAM_API_HASH + - TELEGRM_APP_ID_MASKED (This is your TELEGRM_APP_ID with 'a' at the beginning) + - TELEGRAM_ACCOUNT_PHONE + - LIBRARIES_IO_API_TOKEN +* Don't forget to declare a global network on your server like memes_network in [docker-compose.yml](./docker-compose.yml). + +## How to contribute +First of all install docker and python +Then run the following: +```bash +virtualenv venv +source venv/bin/activate +pip install -r requirements/requirements.dev.txt +pre-commit install +``` +Then you can do changes. diff --git a/logo.png b/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..a4d53ad452b1968f71bb7360d84e8b50c842de23 Binary files /dev/null and b/logo.png differ