8000 feakin/ at master · cloudyan/feakin · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
 
 

README.md

Feakin

Modernize graph assets management, based on Diagram-as-code, so you can create, share and edit diagram. Support for import Mermaid, PlantUML, Excalidraw, Dot and more.

CI codecov npm

Code Coverage

Chinese introduction: Feakin 是一个图形资产管理工具,基于图表即代码 的思想体系,支持导入 Mermaid, PlantUML, Excalidraw, Dot 等图形资产格式。

特性:

  • 跨图表工具转换。支持导入 Mermaid, PlantUML, Excalidraw, Dot 等图形资产格式,并基于 Graph MIR 进行转换。
  • 模板创建。支持创建模板,并基于 Graph MIR 进行转换,转换成其它图表格式。
  • 在线协作编辑。基于 Rope 架构模型和 Graph MIR 进行在线协作编辑。
  • 广泛的图表格式导出。
  • 手绘风格。
  • 多样化图形布局。支持 Dagre、ELK、Cola 等布局。

Demos

Try Online demo: https://online.feakin.com/

Or

Install @feakin/cli for diagrams converter:

npm install -g @feakin/cli

feakin --input software-development.drawio --output sd.excalidraw

Todos

  • Layout Model Design
    • Shape
    • Edge
    • Geometry
  • Render
  • Editor
    • text Editor with Monaco Editor
    • interactive Editor with Graphical Editor
  • Parser
    • Jison with Mermaid
    • Antlr ???
  • Collision Detection
    • SAT.js A simple JavaScript library for performing 2D collision detection
    • [RBush](https://github.com/mourner/rbush is a high-performance JavaScript library for 2D spatial indexing of points and rectangles.
    • JSTS is an ECMAScript library of spatial predicates and functions for processing geometry conforming to the Simple Features Specification for SQL published by the Open Geospatial Consortium.
  • collaboration
  • Publish to CLI
    • upgrade publish script
  • Architecture Features
    • Playground
    • ComponentLess architecture
      • WebComponent, like <feakin data="" layout="" import="" import-type=""></feakin>
    • Templates
      • DDD ?
      • Layered Architecture
      • Test Pyramid
    • Static Pages
      • Feakin Space
    • Export and Import
      • MxGraph
      • Excalidraw
      • PlantUML

Setup

  1. install
npm install --legacy-peer-deps
  1. run by tests

Development

Online demo

Refs

License

@2022 This code is distributed under the MPL license. See LICENSE in this directory.

0