警告
此版本的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集成完成的。