mirror of
https://github.com/didi/KnowStreaming.git
synced 2025-12-24 11:52:08 +08:00
feat: 补充前端打包构建部分文档说明
This commit is contained in:
@@ -1,12 +1,16 @@
|
||||
## 前提
|
||||
|
||||
正常情况下,您应该通过 [本地源码启动手册](https://github.com/didi/KnowStreaming/blob/master/docs/dev_guide/%E6%9C%AC%E5%9C%B0%E6%BA%90%E7%A0%81%E5%90%AF%E5%8A%A8%E6%89%8B%E5%86%8C.md) 来打包工程。如果您有需要在本地独立启动前端服务,请参考以下手册。
|
||||
通常情况下,您可以通过 [本地源码启动手册](https://github.com/didi/KnowStreaming/blob/master/docs/dev_guide/%E6%9C%AC%E5%9C%B0%E6%BA%90%E7%A0%81%E5%90%AF%E5%8A%A8%E6%89%8B%E5%86%8C.md) 来打包工程。如果您需要在本地独立启动或打包前端服务,请参考以下手册。
|
||||
|
||||
在进行以下的步骤之前,首先确保您已经安装了 `node`。如已安装,可以通过在终端执行 `node -v` 来获取到 node 版本,项目推荐使用 `node v12` 版本运行。
|
||||
在进行以下的步骤之前,首先确保您已经安装了 `node`。如已安装,可以通过在终端执行 `node -v` 来获取到 node 版本,项目推荐使用 `node v12` 版本运行(例如 `node v12.22.12`)。
|
||||
|
||||
另外,`windows` 用户请在 `git bash` 下运行下面的命令。
|
||||
|
||||
## 一、安装项目依赖(必须)
|
||||
## 一、进入 km-console 目录
|
||||
|
||||
在终端执行以下步骤时,需要先进入 `KnowStreaming/km-console` 目录。
|
||||
|
||||
## 二、安装项目依赖(必须)
|
||||
|
||||
1. 安装 lerna(可选,安装后可以直接通过 lerna 的全局指令管理项目,如果不了解 lerna 可以不安装)
|
||||
|
||||
@@ -20,9 +24,9 @@ npm install -g lerna
|
||||
npm run i
|
||||
```
|
||||
|
||||
我们默认保留了 `package-lock.json` 文件,以防止可能的依赖包自动升级导致的问题。依赖默认会通过 `https://registry.npmjs.org` 服务下载,如果您无法连通该服务器,请删除当前目录及 `packages/*` 子目录下的 `package-lock.json` 后,在当前目录下使用 `node v12` 版本执行命令 `npm run i`。
|
||||
我们默认保留了 `package-lock.json` 文件,以防止可能的依赖包自动升级导致的问题。依赖默认会通过 taobao 镜像 `https://registry.npmmirror.com/` 服务下载。
|
||||
|
||||
## 二、启动项目
|
||||
## 三、启动项目(可选,打包构建请直接看步骤三)
|
||||
|
||||
```
|
||||
npm run start
|
||||
@@ -37,11 +41,10 @@ npm run start
|
||||
|
||||
如果启动失败,可以参见另外一种本地启动方式 [本地源码启动手册](https://github.com/didi/KnowStreaming/blob/master/docs/dev_guide/%E6%9C%AC%E5%9C%B0%E6%BA%90%E7%A0%81%E5%90%AF%E5%8A%A8%E6%89%8B%E5%86%8C.md)
|
||||
|
||||
## 三、构建项目
|
||||
## 四、构建项目
|
||||
|
||||
```
|
||||
npm run build
|
||||
|
||||
```
|
||||
|
||||
项目构建成功后,会存放到 km-rest/src/main/resources/tamplates 目录下。
|
||||
@@ -53,8 +56,10 @@ npm run build
|
||||
- config-manager-fe: 子应用 - 系统管理
|
||||
- ...
|
||||
|
||||
## 常见问题
|
||||
## QA
|
||||
|
||||
Q: 在 `km-console` 目录下执行 `npm run start` 时看不到应用构建和热加载过程?如何启动单个应用?
|
||||
|
||||
A: 需要到具体的应用中执行 `npm run start`,例如 `cd packages/layout-clusters-fe` 后,执行 `npm run start`。
|
||||
|
||||
如遇到其它问题,请见 [faq](https://github.com/didi/KnowStreaming/blob/master/docs/user_guide/faq.md)。
|
||||
|
||||
@@ -6,13 +6,15 @@
|
||||
npm install
|
||||
```
|
||||
|
||||
注意,这种方式只会安装当前应用的依赖。如果您不了解,推荐在 km-console 目录下执行 npm run i 安装依赖。
|
||||
|
||||
### 启动:
|
||||
|
||||
```
|
||||
npm run start
|
||||
```
|
||||
|
||||
该应用为子应用,启动后需要到基座应用中查看(需要启动基座应用),地址为 http://localhost:8000
|
||||
该应用为子应用,启动后需要到基座应用中查看(需要启动基座应用,即 layout-clusters-fe),地址为 http://localhost:8000
|
||||
|
||||
### 构建:
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
npm install
|
||||
```
|
||||
|
||||
注意,这种方式只会安装当前应用的依赖。如果您不了解,推荐在 km-console 目录下执行 npm run i 安装依赖。
|
||||
|
||||
### 启动:
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user