Kroki项目安装与配置指南

Kroki项目安装与配置指南

kroki Creates diagrams from textual descriptions! 项目地址: https://gitcode.com/gh_mirrors/kr/kroki

1. 项目基础介绍

Kroki是一个开源项目，它能够将文本描述转换为图表。该项目提供了一个统一的API，支持多种图表库，如BlockDiag、BPMN、Bytefield、C4（与PlantUML配合使用）、D2、DBML、Diagram.net（实验性）、Ditaa、Erd、Excalidraw、GraphViz、Mermaid、Nomnoml、Pikchr、PlantUML、SvgBob、Symbolator、UMLet、Vega、Vega-Lite、WaveDrom和WireViz等。

2. 主要编程语言

该项目主要使用JavaScript和Java编程语言。

3. 关键技术和框架

• Java Web Server：基于Vert.x的Java Web服务器，作为网关。
• Nomnoml：基于Node.js的CLI，用于生成Nomnoml图表。
• Vega：基于Node.js的CLI，用于生成Vega和Vega-Lite图表。
• Mermaid：基于JavaScript的Web服务器，提供Mermaid图表库。
• bpmn-js：基于JavaScript的Web服务器，提供bpmn-js图表库。
• micro：用于创建Web服务器的JavaScript框架。

4. 安装和配置准备工作

在开始安装Kroki之前，请确保您的系统中已安装以下依赖项：

• Java：用于构建和运行Java Web服务器。
• Node.js：用于运行Node.js CLI工具。
• Docker：用于运行Docker容器（可选，但推荐）。
• Git：用于克隆项目代码。

5. 详细安装步骤

克隆项目

首先，克隆项目到本地目录：

git clone https://github.com/yuzutech/kroki.git
cd kroki

构建项目

使用Maven构建Java Web服务器：

mvn clean install

运行Java Web服务器

构建完成后，可以通过以下命令运行Java Web服务器：

java -jar target/kroki-standalone.jar

或者，如果您使用Docker，可以构建并运行Docker容器：

docker build -t kroki .
docker run -d -p 8000:8000 kroki

运行Node.js CLI工具

对于某些图表库，您可能需要运行相应的Node.js CLI工具。例如，要运行Nomnoml工具，可以使用以下命令：

npm install
npm run nomnoml

使用Docker Compose运行 companion容器

如果您想要使用Mermaid、BPMN、Excalidraw等图表库，可以创建一个docker-compose.yml文件来运行相应的companion容器：

version: '3.8'

services:
  core:
    image: yuzutech/kroki
    environment:
      - KROKI_MERMAID_HOST=mermaid
      - KROKI_BPMN_HOST=bpmn
      - KROKI_EXCALIDRAW_HOST=excalidraw
    ports:
      - "8000:8000"
  mermaid:
    image: yuzutech/kroki-mermaid
    expose:
      - "8002"
  bpmn:
    image: yuzutech/kroki-bpmn
    expose:
      - "8003"
  excalidraw:
    image: yuzutech/kroki-excalidraw
    expose:
      - "8004"

然后，启动所有服务：

docker-compose up -d

现在，您应该已经成功安装和配置了Kroki项目，并且可以使用它来生成图表了。

kroki Creates diagrams from textual descriptions! 项目地址: https://gitcode.com/gh_mirrors/kr/kroki