警告
此版本的Torchbox.com倉庫現已退休。您可能想要https://github.com/torchbox/torchbox.com。
舊的Reame內容在下面保存以供參考。
* * * * * * * * * *
這是主要的Torchbox.com網站。該網站的職業部分可以在Torchbox/Careers中找到。
該項目包含/docs文件夾中的Markdown中編寫的技術文檔。這涵蓋了:
您可以通過運行使用mkdocs查看它:
mkdocs serve該文檔將在以下網址提供:http:// localhost:8001/
該存儲庫包括用於在本地Docker容器中運行項目的docker-compose配置,以及用於配置和管理此項目的Fabfile。
還有許多其他命令可以使用Fabric腳本來幫助開發。要看到所有人,請運行:
fab -l運行本地環境需要以下內容。指定的最低版本已確認可以正常工作:如果您已經安裝了較舊的版本,則可能會工作,但不能保證這樣做。
請注意,在Mac OS上,如果您安裝了較舊版本的面料,則可能需要卸載舊版本,然後將新版本安裝在Pip3:
pip uninstall fabric
pip3 install fabric您可以通過設置pyenv來管理不同的Python版本:https://realpython.com/introto-to-to-pyenv/
此外,對於與生產 /分期環境進行互動,您需要:
如果您使用的是Docker桌面,請確保資源:文件共享設置允許將克隆的目錄安裝在Web容器中(避免在構建步驟結束時mounting OCI運行時故障)。
可以通過運行來完成本地構建:
git clone [email protected]:torchbox/wagtail-torchbox.git
cd wagtail-torchbox
fab build
fab migrate
fab start這將在背景中啟動容器,而不是Django。為此,請使用fab sh連接到Web容器,然後運行honcho start在前景中啟動Django和WebPack Dev Server。
然後,再次連接到運行容器( fab sh ),然後:
dj createcachetable
dj createsuperuser該網站應在主機機上提供:http://127.0.0.1:8000/
如果您只想運行前端或後端工具, honcho命令在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=local創建一個.env文件(請參見.env.example )。 fab start將不再啟動frontend容器。現在,當運行fab start時,Docker不會嘗試綁定到前端Dev服務器所需的端口,這意味著它們可以在本地運行。所有工具仍然在容器中可用。 可以在Web容器中使用poetry安裝Python軟件包:
fab sh
poetry add wagtail-guide
重置已安裝的依賴項回到poetry.lock中的方式:lock文件:
fab sh
poetry install --no-root
要部署,請將您的功能分支合併到master或staging分支。 CI管道通過後,它將自動部署到相應的Heroku站點。
這是通過Heroku Github集成完成的。