项目简介
本项目 YuanZhou - Build 是基于 ice 和 midway 框架的 node 中后台应用项目,运用 TypeScript 开发,涵盖前端与后端开发内容,主要用于搭建系统 cms 的 demo。
项目的主要特性和功能
- 采用微前端架构,借助 ice 体系中的 icestark,可灵活拆分和组合应用。
- 实现 Swagger 接口自动化,通过 egg 生态中的 egg - swagger - doc 自动生成和管理接口文档。
- 应用装饰器,包含自定义装饰器,简化代码量,提高开发效率。
- 制定前后端研发规范文档,涉及 lint、ci、目录命名、git flow 等规范。 目前仅完成 demo 级功能开发,实现了会场模板表和基础物料表的增删改查功能,且提供前后端研发文档,方便开发者进行项目开发。
安装使用步骤
- 假设用户已下载项目的全部源码文件。
- 安装依赖:在项目根目录下执行
npm install
或yarn install
安装所有依赖。 - 启动项目:
- 前端部分:在
client - framework
和client - child
目录下分别启动,通过访问localhost:3333
和localhost:3334
访问主应用和子应用。 - 后端部分:在
server
目录下启动,默认端口为 7000。
- 前端部分:在
- 运行和测试:启动完成后,通过浏览器访问前端页面并进行操作测试,同时可通过 swagger - ui 页面查看和测试后端接口。
注意:此项目为教学或 demo 目的创建,功能相对简单,仅适用于学习和研究用途。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】