说明

这个目录主要用于存放开发记录，帮助其他开发者理解我要做什么，以及是怎么做的。如果后期有人愿意加入进来一起开发的话，可以以该部分作为指导手册。

让开发者可以部署起来。

文档

基伴使用VuePress (opens new window)生成文档系统。

• 预览

你可以使用如下命令在本地生成预览文档：

yarn docs:dev

• build

yarn docs:build

• 更新

从 master/dev 分支合并更新

git checkout docs # 因为目录存在docs，所以使用`git switch docs` 切换分支或者 `git checkout master` 切换到 master 分支
git pull
git checkout dev docs/*  # dev为要合并的分支，docs为要合并的目录

• lint 文档

yarn docs:lint-md

预览

前端

cd frontend
yarn install
yarn run dev

后端

• 安装开发环境 目前使用pip-compile-multi (opens new window) 管理项目依赖的更新。

cd backend
python3 -m venv fmp
source fmp/bin/activate
pip install -Ur requirements/dev.txt

TIP

如果使用默认源不够快可以考虑换源：

pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/

pip config set install.trusted-host mirrors.aliyun.com

• 修改环境变量.env

flask run --host=0.0.0.0

• 安装生产环境依赖

# fundmate/backend
pip install -Ur requirements/base.txt

• 更新依赖

pip-compile-multi

如果报错UnicodeDecodeError: 'gbk' codec can't decode byte 0xaf in position 87: illegal multibyte sequence，可能是编码问题，需要配置set PYTHONUTF8=1然后重新执行。

启动数据库

• 初始化数据库

flask init-db # 更多命令执行flask --help 查看

数据来源

1. http://fund.eastmoney.com/js/fundcode_search.js 数据 13420 条
2. https://api.doctorxiong.club/v1/fund/all 数据 11736 条
3. http://fund.eastmoney.com/fund.html 数据 11493 条

• 更新基金相关数据

# 默认只更新基金信息
flask update-db