Быстрый старт#
Эта инструкция поможет вам быстро начать работу с проектом.
Получение исходного кода#
Код проекта хранится на GitHub. Для получения кода клонируйте репозиторий:
git clone https://github.com/techwri/techwritersru.git
Каталог с файлами репозитория далее будет называться рабочим каталогом. Все приведенные ниже команды следует выполнять в рабочем каталоге.
Сборка проекта#
Рекомендуемым способом сборки проекта является использование Docker-образа. Если по какой-либо причине этот способ не подходит, можно использовать виртуальное окружение Python.
Docker#
Чтобы собрать проект с помощью Docker-образа, выполните следующие действия:
Установите Docker Desktop, следуя инструкциям для вашей ОС.
Соберите Docker-образ:
make docker-build-image
Для удобства использования образу присваивается тег
techwriters
.Для сборки проекта выполните команду:
make docker-build-html
Виртуальное окружение Python#
Чтобы собрать проект с помощью виртуального окружения Python, выполните следующие действия:
Установите интерпретатор Python версии 3.8 или новее.
Установите менеджер Python-пакетов PIP, если он не был установлен вместе с интерпретатором.
Установите пакет
venv
для управления виртуальными окружениями, если он не был установлен вместе с интерпретатором.Note
Подробнее о пакете
venv
см. в документации Python.Создайте виртуальное окружение:
python3 -m venv .env
Активируйте созданное виртуальное окружение:
source .env/bin/activate
Установите пакеты, список которых представлен в файле
requirements.txt
.pip install -r requirements.txt
Для сборки сайта выполните команду:
make html
Запуск локального сервера#
Для запуска локального сервера выполните следующие действия:
Установите интерпретатор Python версии 3.8 или новее.
Соберите проект любым описанным выше способом.
Выполните команду:
python3 -m http.server -d build/dirhtml
Собранный сайт будет доступен локально по адресу http://127.0.0.1:8080/.