update documentation

This commit is contained in:
Alexander Popov 2025-05-02 01:39:02 +03:00
parent 22866616eb
commit d48280ec7b
Signed by: iiiypuk
GPG Key ID: E47FE0AB36CD5ED6
2 changed files with 17 additions and 5 deletions

View File

@ -15,12 +15,24 @@ include_toc: true
## 💽 Установка и использование ## 💽 Установка и использование
### ⬇️ Загрузка проекта
Первым делом необходимо скачать приложение.
```sh
# Скачиваем приложение и переходим в скачанную директорию
git clone https://git.a2s.su/AniCard/ClanStat.git
cd ClanStat
```
### 📄 Подготовка файла конфигурации ### 📄 Подготовка файла конфигурации
Настройки приложения хранится в файле `.env`. Настройки приложения хранится в файле `.env`.
Пример файла с настройками называется `env.example`. Пример файла с настройками называется `env.example`.
```sh ```sh
# Копируем файл с примером конфигурации
cp env.example .env cp env.example .env
``` ```

View File

@ -11,15 +11,15 @@ class DataBase(object):
def __init__(self, host: str, port: int, name: str, user: str, password: str): def __init__(self, host: str, port: int, name: str, user: str, password: str):
super(DataBase, self).__init__() super(DataBase, self).__init__()
self.host = host self.host = host
"""Хост PostgreSQL базы данных""" """🖥️ Хост PostgreSQL базы данных"""
self.port = port self.port = port
"""Порт сервера базы данных""" """🔟 Порт сервера базы данных"""
self.name = name self.name = name
"""Имя базы данных""" """🏷️ Имя базы данных"""
self.user = user self.user = user
"""Имя пользователя""" """🥸 Имя пользователя"""
self.password = password self.password = password
"""Пароль пользователя""" """🔐 Пароль пользователя"""
def connect(self) -> bool: def connect(self) -> bool:
"""Выполняет подключение к базе данных""" """Выполняет подключение к базе данных"""