karkas/src/gnomik/README.md

# Gnomик

![Логотип](./docs/gnomik.jpg)

Чат-бот помощник в [ALT Gnome Chat](https://t.me/alt_gnome_chat).


ALT Regular Gnome Community - открытое сообщество пользователей операционной системы ALT Regular Gnome.

- [Канал](https://t.me/alt_gnome)
- [Wiki](https://alt-gnome.wiki)

## Описание

Gnomик - это чат-бот для Telegram, разработанный на платформе Karkas. Он предоставляет различные функции и возможности, помогающие пользователям операционной системы ALT Regular Gnome.

## Функционал

<!--
TODO: описать функционал
-->

## Запуск

### Docker

1. Соберите Docker-образ:
    ```bash
    docker build -t gnomik .
    ```
2. Запустите контейнер:
    ```bash
    docker run -p 9000:9000 -v ./config.yaml:/app/config.yaml -v ./database:/app/database gnomik
    ```

    Замените `./config.yaml` и `./database` на пути к вашим локальным файлам конфигурации и паки для базы данных.

### Вручную

1. Активируйте виртуальное окружение Gnomика:
    ```bash
    poetry shell
    ```
2. Запустите бота:
    ```bash
    python -m gnomik
    ```

## Конфигурация

Конфигурация бота находится в файле `config.yaml`.

## Модули

Список загружаемых модулей указан в файле `__main__.py`.