mirror of
https://github.com/didi/KnowStreaming.git
synced 2025-12-24 20:22:12 +08:00
cf9d5b6832
请不要在没有先创建Issue的情况下创建Pull Request。 ## 变更的目的是什么 XXXXX ## 简短的更新日志 XX ## 验证这一变化 XXXX 请遵循此清单，以帮助我们快速轻松地整合您的贡献： * [ ] 一个 PR（Pull Request的简写）只解决一个问题，禁止一个 PR 解决多个问题； * [ ] 确保 PR 有对应的 Issue（通常在您开始处理之前创建），除非是书写错误之类的琐碎更改不需要 Issue ； * [ ] 格式化 PR 及 Commit-Log 的标题及内容，例如 #861 。PS：Commit-Log 需要在 Git Commit 代码时进行填写，在 GitHub 上修改不了； * [ ] 编写足够详细的 PR 描述，以了解 PR 的作用、方式和原因； * [ ] 编写必要的单元测试来验证您的逻辑更正。如果提交了新功能或重大更改，请记住在 test 模块中添加 integration-test； * [ ] 确保编译通过，集成测试通过；
使用说明
依赖安装（如在 km-console 目录下执行 npm run i 安装过依赖，这步可以省略）：
npm install
注意，这种方式只会安装当前应用的依赖。如果您不了解，推荐在 km-console 目录下执行 npm run i 安装依赖。
启动：
npm run start
启动后访问地址为 http://localhost:8000
构建：
npm run build
构建后的代码默认会存放到项目根路径下 km-rest/src/main/resources/templates/layout 文件夹里
目录结构
- config: 开发 & 构建配置
- theme.js: antd 主题配置
- registerApps.js: SPA 注册
- systemsConfig.js: 子应用配置
- d1-webpack.base.js: webpack 基础配置
- CoverHtmlWebpackPlugin.js: 输出 html 内容
- CountComponentWebpackPlugin.js: 计算 knowdesign 组件引用次数
- webpackConfigResolveAlias.js: 文件路径别名配置
- src：源代码所在目录
- @types: TypeScript 全局类型声明
- api: 请求定义
- assets：全局资源 img、css
- components：公共组件
- constants: 全局配置、通用方法
- locales: 国际化语言
- pages: 路由匹配的页面组件
- app.tsx: 菜单、路由配置组件
- index.html: 单页
- index.tsx: 入口文件
- tsconfig.json: TypeScript 配置
- webpack.config.js: webpack 配置入口