# 动态图表组件库

## 开发

- 开发模式

  ```bash
  npm run dev
  ```

- 开发模式（同时开启 web 服务）

  ```bash
  npm run dev-serve
  ```

- Lint 代码

  ```bash
  npm run lint
  ```

  如果使用 VS Code，推荐安装 ESLint 和 Prettier 插件。

- 运行测试

  ```bash
  npm run test # npm run test:watch
  ```

- 构建打包

  ```bash
  npm run build
  ```

- 类型检查 & 生成类型定义文件

  ```bash
  npm run build:types
  ```

- 根据 markdown 生成 html 文档

  ```bash
  npm run build:docs-html
  ```

## 构建产物

运行 `npm run build`, 最终将生成以下捆绑包。

```plain
types/
build/
├── bundle.esm.js
├── bundle.esm.min.js
├── bundle.umd.js
└── bundle.umd.min.js
```

还将生成相应的 **sourcemap** 文件。

_注意_：产物文件名中带 `.min` 的为生产环境包，会将 `console.log()` 等开发环境中调试的信息剔除掉，建议生产环境中使用该包。

## 相关文档

- [架构概述](./docs/ARCHITECTURE.md)
- [贡献指南](./CONTRIBUTING.md)
- [更新日志](./CHANGELOG.md)

> [UI 设计稿（共享盘）](<file://172.20.54.216/home/UI%E8%A7%84%E8%8C%83%E4%B8%8E%E7%B4%A0%E6%9D%90/%E6%95%B0%E6%8D%AE%E5%8F%AF%E8%A7%86%E5%8C%96%E8%A7%84%E8%8C%83/%E5%8A%A8%E6%80%81%E5%8F%AF%E8%A7%86%E5%8C%96%E8%AE%BE%E8%AE%A1%E8%A7%84%E8%8C%83/%E5%8A%A8%E6%80%81%E5%8F%AF%E8%A7%86%E5%8C%96%E8%A7%84%E8%8C%83%E8%AE%BE%E8%AE%A1/%E6%97%B6%E9%97%B4%E8%BD%B4(%E8%A7%84%E8%8C%83%E8%B4%9F%E8%B4%A3%E4%BA%BA%EF%BC%9A%E5%BC%A0%E7%8E%89%E5%8D%8E%E3%80%81%E9%92%B1%E5%AE%87%E6%A5%A0%E3%80%81PC%E5%88%98%E6%96%87%E6%96%8C)/[%E7%A7%BB%E5%8A%A8%E7%AB%AF]220708%20%E6%97%B6%E9%97%B4%E8%BD%B4%E6%A0%87%E6%B3%A8%E7%A8%BF/index.html>)

详细的文档见 [paradigm-chart-docs](../paradigm-chart-docs/docs/more/paradigm-timeline-docs/index.md) 项目。

## 维护人员

- @王渊(前端开发)
- @钱宇楠(UI 设计)