未提供项目描述
项目描述
合山羊
什么是合子?
zygoat
是一个命令行工具,用于引导和配置 React/Django/Postgres 堆栈 Web 应用程序。
Linting、测试配置、样板和开发环境会自动使用zygoat
,以便您可以更快地启动和运行。
zygoat
还包括预设的部署配置,允许您使用单个命令将堆栈部署到 AWS 环境。您将获得完整的无服务器 AWS 堆栈,以保持成本低廉且灵活。
它是如何工作的?
zygoat
工作原理是将Components
, 定义为项目的一部分,然后根据您是创建新项目、更新现有项目还是删除不再需要的组件来定义如何实现这些组件。
例如,对于 python 后端,我们想要包含black
,这是一个以标准方式自动格式化 python 代码以使其符合 pep8 的工具。要black
为项目的 python 后端部分安装,我们Component
为它创建一个,特别是一个FileComponent
,它定义了我们如何处理项目中需要的文件。然后我们将Black
组件(在black.py中定义)与Backend
组件(在backend/__init__.py中定义)注册为子组件。这样,每当您使用组件创建或更新(或删除)项目时Backend
,您将对组件执行相同的“阶段” Black
。
安装
pip install --upgrade zygoat
用法
mkdir my-cool-new-app && cd my-cool-new-app
git init
zg new my-cool-new-app
如需更多自定义和配置,请查看官方文档。
我如何为它开发变化?
在某处创建一个新的 git 存储库,我们将其命名为 test-zg
mkdir test-zg && cd test-zg
git init
本地安装zygoat包
pip install --user --upgrade ~/Projects/zygoat # Or wherever you have it
如果您使用的是 asdf 版本管理器,请 reshim
asdf reshim python
运行zg命令,看看是否失败
zg new test
zg update
zg delete
贡献
zygoat
是使用 Python 项目的Poetry打包框架开发的,以使开发尽可能简单和可移植。