pyproger/README.md

68 lines
3.2 KiB
Markdown
Raw Normal View History

# Pyproger blog
2023-09-16 10:31:08 +03:00
### Описание
Данный проект начинался как pet-проект в рамках изучения фреймворка Flask, но решил выпустить его в "свет".
Проект полностью написан на телефоне с андроидом на борту🙂, о чем буду рассказывать в этом блоге.
Блог доступен по адресу https://pyproger.ru
### Возможности
- Админ панель управления контентом
- Отображение всех записей с пагинацией
- Добавление тэгов к статьям
- Отображение статей по тэгам
### Зависимости
- Для работы сервиса необходима установленная СУБД postgresql. Создана база данных и пользователь с правами на нее.
- poetry - Система управления зависимостями в Python.
Остальное добавиться автоматически на этапе установки.
### Установка
Установите и настройте postgresql согласно офф. документации. Создайте пользователя и бд.
Установите (если еще не установлены) python и python-pip, git
Установите систему управления зависимостями
> `$ pip install poetry`
Клонируйте репозиторий
> `$ git clone https://git.pi3c.ru/pi3code/pyproger.git`
Перейдите в каталог, создайте и запустите виртуальное окружение
> `$ cd pyproger`
> `$ poetry install`
> `$ poetry shell`
Запустите скрипт создания начальной конфигурации.
> `$ python ./generate_dotenv.py`
Скрипт запросит данные необходимые для подключения к бд и создаст .env файл с "секретами" необходимыми для работы.
Примените миграции в базу данных и создайте учетную запись Администратора
> `$ flask db upgrade`
> `$ flask create-superuser <nik>`
где <nik> замените своим логином, ответьте на вопросы.
Данные этого пользователя будут необходимы для входа в административную часть сайта
Запустите приложение
> `$ flask run`
Перейдите в браузере по адресу 127.0.0.1:5000 для доступа к блогу или 127.0.0.1:5000/admin в админ панель
2023-10-21 10:16:24 +03:00
### TODO
- Добавить на страницы постов "Оглавление" со ссылками на статьи
- Добавить подписку на статьи
### Авторы
- Сергей Ванюшкин <pi3c@yandex.ru>
### Лицензия
Распространяется под [MIT лицензией](https://www.opensource.org/licenses/mit-license.php).
Подробнее на русском в файле LICENSE.md