feat #35 增加源码运行说明

.github/workflows/build_client.yml

@@ -10,7 +10,7 @@ jobs:
       runs-on: ${{ matrix.os }}
       strategy:
         matrix:
-          os: [ windows-latest, macos-latest, ubuntu-latest ]
+          os: [ windows-latest, macos-latest ]
       steps:
         - name: 拉代码
           uses: actions/checkout@v3

README.md

@@ -14,7 +14,61 @@
 
 > 使用过程中有疑问、或其他宝贵意见 -> [issues](https://github.com/zy7y/dfs-generate/issues)，如果你对这个项目感兴趣，欢迎加入共同实现，
 
-## Star History
+# 源码运行
+<details>
+<summary>查看详情</summary>
+
+> 注意：开发使用环境 Node18.15 Python3.11，不低于该要求最佳。
+
+## 1. 下载源码
+```shell
+git clone https://github.com/zy7y/dfs-generate.git
+```
+
+> 以下命令均在源码根目录执行
+## 2. 前端
+### 进入目录
+```shell
+cd web
+```
+### 安装依赖
+```shell
+npm i
+```
+### 打包编译
+```shell
+npm run build
+```
+
+## 3. 后端
+### 虚拟环境（可选）
+```shell
+python -m venv venv
+
+# windows 激活虚拟环境
+venv\Scripts\activate
+
+# mac 、linux 激活虚拟环境
+source venv/bin/activate
+```
+### 安装依赖
+```shell
+pip install -r requirements.txt 
+```
+### 运行
+```shell
+python dfs_generate/server.py
+```
+### 访问
+> 注意：端口8080，请确保该端口未被占用
+```shell
+http://127.0.0.1:8080
+```
+</details>
+
+# [更新日志](/docs/CHANGELOG.md)
+
+# Star History
 <!-- STAR_HISTORY -->
 
 [![Star History Chart](https://api.star-history.com/svg?repos=zy7y/dfs-generate&type=Date)](https://star-history.com/#zy7y/dfs-generate&Date)
@@ -26,11 +80,8 @@
 
 <!-- CONTRIBUTORS_SECTION -->
 <!-- /CONTRIBUTORS_SECTION -->
-<details>
-<summary>WeChat打赏</summary>
 
+# 赞赏
 ![wechat](docs/wechat.jpeg)
 
-</details>
-
 

docs/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+## Release v0.2.0 （2024-04-27）
+- #30 支持Tortoise ORM 代码生成
+- #27 移除依赖`FastAPI`,`SQLAlchemy`,`Pydantic`,`Uvicorn`, `Jinja2`...
+- 优化目录结构
+
+## Release v0.1.x (2023-12 ~ 2023-04-27)
+- 支持SQLModel
+- 生成FastAPI接口`详情查询`,`更新`,`新增`,`删除`,`分页查询`