update documentation
This commit is contained in:
parent
22866616eb
commit
d48280ec7b
12
README.md
12
README.md
@ -15,12 +15,24 @@ include_toc: true
|
||||
|
||||
## 💽 Установка и использование
|
||||
|
||||
### ⬇️ Загрузка проекта
|
||||
|
||||
Первым делом необходимо скачать приложение.
|
||||
|
||||
```sh
|
||||
# Скачиваем приложение и переходим в скачанную директорию
|
||||
git clone https://git.a2s.su/AniCard/ClanStat.git
|
||||
cd ClanStat
|
||||
```
|
||||
|
||||
|
||||
### 📄 Подготовка файла конфигурации
|
||||
|
||||
Настройки приложения хранится в файле `.env`.
|
||||
Пример файла с настройками называется `env.example`.
|
||||
|
||||
```sh
|
||||
# Копируем файл с примером конфигурации
|
||||
cp env.example .env
|
||||
```
|
||||
|
||||
|
10
app/db.py
10
app/db.py
@ -11,15 +11,15 @@ class DataBase(object):
|
||||
def __init__(self, host: str, port: int, name: str, user: str, password: str):
|
||||
super(DataBase, self).__init__()
|
||||
self.host = host
|
||||
"""Хост PostgreSQL базы данных"""
|
||||
"""🖥️ Хост PostgreSQL базы данных"""
|
||||
self.port = port
|
||||
"""Порт сервера базы данных"""
|
||||
"""🔟 Порт сервера базы данных"""
|
||||
self.name = name
|
||||
"""Имя базы данных"""
|
||||
"""🏷️ Имя базы данных"""
|
||||
self.user = user
|
||||
"""Имя пользователя"""
|
||||
"""🥸 Имя пользователя"""
|
||||
self.password = password
|
||||
"""Пароль пользователя"""
|
||||
"""🔐 Пароль пользователя"""
|
||||
|
||||
def connect(self) -> bool:
|
||||
"""Выполняет подключение к базе данных"""
|
||||
|
Loading…
x
Reference in New Issue
Block a user