# archguard-frontend

**Repository Path**: yourkeychen/archguard-frontend

## Basic Information

- **Project Name**: archguard-frontend
- **Description**: ArchGuard 是一个架构治理工具，用于管理和分析组织级别的软件架构。 结合 C4 模型，进行依赖分析，含容器级别（服务级别）、组件级别（/模块级别）、代码级别、数据库级别等。 同时，可以创建系统的架构适应度函数，度量系统的各项指标。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2022-04-10
- **Last Updated**: 2022-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 工具, 架构治理, 前端

## README

# ArchGuard Frontend

[![CI](https://github.com/archguard/archguard-frontend/actions/workflows/ci.yml/badge.svg)](https://github.com/archguard/archguard-frontend/actions/workflows/ci.yml)
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/archguard/archguard-frontend)

## Development

Node.js version: 16.x

### Tech decision (framework)

- language：TypeScript
- framework：React, UMI
- graph engine: 
  - Antv/g6 for **Package** dependencies analysis
  - Cytoscape for **Class**, **Method** dependencies analysis
  - D3.js for custom layout in Dashboard
  - bizcharts for badsmell overview
- lint：ESLint
- build tool：yarn

### Local setup

```
cd archguard
yarn install
yarn start
```

### Docker setup

```
cd archguard
docker build -t archguard-frontend:latest .
docker run -it --rm -p 3000:80 archguard-frontend:latest
```

## Graph Engine

- Antv/g6, for Package dependencies
  - with `ant-design/charts`
- Cytoscape, for Class & Method dependencies 
  - ext: `darge`, `cola`, `fcose`, ~~elk~~


License
---

[ServiceMap graph](archguard/src/pages/servicesMap/graph) copy from ElasticSearch with SSPL license.

@ 2020 ~ Thoughtworks. This code is distributed under the MPL license. See `LICENSE` in this directory.