wagtail torchbox
1.0.0
Предупреждение
Эта версия Torchbox.com Repo теперь выходит на пенсию. Вы, вероятно, хотите https://github.com/torchbox/torchbox.com.
Старый контент Reame сохранился ниже для справки.
* * * * * * * * * *
Это главный веб -сайт Torchbox.com. Раздел «Карьера этого сайта» можно найти в Torchbox/Careers.
Этот проект содержит техническую документацию, написанную в Markdown в папке /docs . Это покрывает, среди прочего:
Вы можете просмотреть его, используя mkdocs , работая:
mkdocs serveДокументация будет доступна по адресу: http: // localhost: 8001/
Этот репозиторий включает в себя конфигурацию docker-compose для запуска проекта в локальных контейнерах Docker, а также Fabfile для обеспечения и управления этим.
Есть ряд других команд, которые помогут с разработкой, используя сценарий ткани. Чтобы увидеть их всех, беги:
fab -lДля запуска местной среды требуется следующее. Указанные минимальные версии подтверждаются, что они работают: если у вас уже установлены более старые версии, они могут работать, но не гарантированно это сделают.
Обратите внимание, что на Mac OS, если у вас установлена старая версия ткани, вам может потребоваться удалить старую, а затем установить новую версию с помощью PIP3:
pip uninstall fabric
pip3 install fabric Вы можете управлять различными версиями Python, настройка pyenv : https://realpython.com/intro-to-pyenv/
Кроме того, для взаимодействия со средами производства / постановки вам понадобится:
Если вы используете Docker Desktop, убедитесь, что ресурсы: настройки обмена файлами позволяют устанавливать клонированный каталог в веб -контейнере (избегая mounting сбоев выполнения OCI в конце шага сборки).
Запуск локальной сборки может быть выполнена путем запуска:
git clone [email protected]:torchbox/wagtail-torchbox.git
cd wagtail-torchbox
fab build
fab migrate
fab start Это запустит контейнеры на заднем плане, но не Django. Для этого подключитесь к веб -контейнеру с fab sh и запустите honcho start чтобы начать как Django, так и на сервере Webpack Dev на переднем плане.
Затем снова подключитесь к работающему контейнеру ( fab sh ) и:
dj createcachetable
dj createsuperuserСайт должен быть доступен на хост -машине по адресу: http://127.0.0.1:8000/
Если вы хотите только запустить инструмент Frontend или Backend, команды honcho Runs находятся в docker/Procfile .
При первом запуске контейнера статические файлы могут не существовать или могут быть устаревшими. Чтобы решить это, просто запустите npm run build .
Вот общие команды:
# Install front-end dependencies.
npm install
# Start the Webpack build in watch mode, without live-reload.
npm run start
# Start the Webpack server build on port 3000 only with live-reload.
npm run build
# Do a one-off Webpack production build.
npm run build:prodЕсть два способа запустить инструмент Frontend:
.env в корне проекта ( FRONTEND=local .env.example fab start больше не запускает контейнер frontend . Теперь, при fab start , Docker не будет пытаться привязать к портам, необходимым для Frontend Dev, то есть их можно запустить локально. Все инструменты по -прежнему остаются доступными в контейнере. Пакеты Python могут быть установлены с использованием poetry в веб -контейнере:
fab sh
poetry add wagtail-guide
Чтобы сбросить установленные зависимости обратно в то, как они находятся в файле poetry.lock :
fab sh
poetry install --no-root
Чтобы развернуть, объедините филиал функции, чтобы master или staging филиал. Как только трубопроводы CI пройдут, он будет развернут на соответствующий сайт Heroku автоматически.
Это делается с помощью интеграции Heroku Github.
