К содержимому

Установка

Итак, для того чтобы начать работать с Шиори, для начала надо её установить.

Процесс установки довольно просто и состоит из нескольких простых шагов.

  1. Клонирование репозитория.
Окно терминала
git clone https://git.miroq.ru/chio/cord
  1. Установите зависимости через uv.
Окно терминала
uv sync --all-groups

--all-groups используется чтобы загрузить все дополнительные зависимости как для плагинов, так и инструменты для разработчиков.

  1. Скопируйте .env.dist в .env и проведите базовую настройку.

  2. Проведите тестовые запуск бота.

Окно терминала
uv run -m chioricord

Для того чтобы использовать бота, вам нужно создать базу данных Postgres и выдать доступ к ней для бота. Давайте рассмотрим на примере Linux.

  1. Установите пакет базы данных и проведите первичный запуск.

  2. Создайте пользователя и базу данных для бота.

Окно терминала
sudo -u postgres psql

Создадим пользователя:

CREATE USER chio WITH PASSWORD 'please_change_me';

А теперь базу данных:

CREATE DATABASE chat WITH OWNER chio;

Теперь, при такой настройке, ваши данные для подключения будут выглядеть вот так:

DB_DSN = "postgres://chio:change_me_please@/run/postgresql/chio"

Для того чтобы обновить проект до актуальной версии, достаточно сделать pull:

Окно терминала
git pull

Теперь, когда вы установили Шиори, можно

  • config: Более подробно о настройках бота.
  • contribute: Способы поддержать проект.
  • guides: Раздел обучения написания новых функций.