开发¶
设置开发环境¶
如果您想参与 Fava 的开发或运行最新的开发版本,请确保已安装以下组件的足够新版本(建议使用系统包管理器安装):
Python 3 - 因为 Fava 是用 Python 编写的,
Node.js - 配备 npm,用于构建前端,
Make - 用于运行各种构建/检查/测试目标,
uv - 用于安装开发环境并运行脚本。
然后,执行以下命令即可开始运行:
git clone https://github.com/beancount/fava.git
cd fava
# setup a virtual environment (at .venv) and install Fava and development
# dependencies into it:
make dev
您可以通过运行 fava 在虚拟环境中像平常一样启动 Fava。使用 fava --debug 以调试模式运行对开发非常有用。
您可以使用 make test 运行测试,并通过运行 make lint 运行代码检查工具。还有其他 make 目标,请参阅 Makefile 了解详细信息。在对 JavaScript 代码进行任何更改后,您需要重新构建前端,可通过运行 make 完成。如果您正在开发前端代码,在 frontend 文件夹中运行 npm run dev 将监视文件更改并持续重新构建 JavaScript 包。
如果您需要比最新发布版本更新的 Beancount 版本,可以按如下方式从源码安装(更多详情请参见 此处):
pip install git+https://github.com/beancount/beancount@v2
我们非常欢迎您的贡献,请在 GitHub 上提交拉取请求。
Fava 采用 MIT 许可证 发布。