{"id":13906560,"url":"https://github.com/feakin/feakin-web","last_synced_at":"2025-07-18T04:31:54.012Z","repository":{"id":45299379,"uuid":"513496518","full_name":"feakin/feakin-web","owner":"feakin","description":"Feakin 是一个架构设计与可视化协作工具。Feakin is a architecture design and visual collaboration tool.","archived":false,"fork":false,"pushed_at":"2022-11-20T06:24:28.000Z","size":8399,"stargazers_count":96,"open_issues_count":2,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-08-07T23:48:22.942Z","etag":null,"topics":["collaboration","diagram-as-code"],"latest_commit_sha":null,"homepage":"https://online.feakin.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/feakin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-13T11:35:45.000Z","updated_at":"2024-07-06T04:29:30.000Z","dependencies_parsed_at":"2023-01-23T03:00:36.379Z","dependency_job_id":null,"html_url":"https://github.com/feakin/feakin-web","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feakin%2Ffeakin-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feakin%2Ffeakin-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feakin%2Ffeakin-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feakin%2Ffeakin-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/feakin","download_url":"https://codeload.github.com/feakin/feakin-web/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226344702,"owners_count":17610188,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["collaboration","diagram-as-code"],"created_at":"2024-08-06T23:01:38.208Z","updated_at":"2024-11-25T14:31:52.094Z","avatar_url":"https://github.com/feakin.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Feakin\n\n\u003e Modernize architecture visualization assets management, based on Diagram-as-code, so you can create, share and edit diagram. Support for import Mermaid, PlantUML, Excalidraw, Dot and more.\n\n[![CI](https://github.com/feakin/feakin/actions/workflows/ci.yml/badge.svg)](https://github.com/feakin/feakin/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/feakin/feakin/branch/master/graph/badge.svg?token=XO0930Z3TE)](https://codecov.io/gh/feakin/feakin) ![npm](https://img.shields.io/npm/v/@feakin/parser)\n\n[![Code Coverage](https://codecov.io/gh/feakin/feakin/branch/master/graphs/tree.svg?token=XO0930Z3TE)](https://app.codecov.io/gh/feakin/feakin)\n\nChinese introduction: Feakin 是一个架构资产可视化管理工具。基于[图表即代码](https://www.phodal.com/blog/diagram-as-code/) 的思想体系，支持导入 Mermaid, PlantUML, Excalidraw, Dot 等图形资产格式。\n\nCore Technical: \n\n- concepts: Collaboration (CRDT) + DSL (pest.rs) + Graph Engine + Editor Language (Monaco)\n- stacks: Rust( + WASM) + React + TypeScript\n\n特性：\n\n- Graph\n  - [x] 跨图工具转换。支持导入 Mermaid, PlantUML, Excalidraw, Dot 等图形资产格式，并基于 Graph MIR 进行转换。\n  - [x] 广泛的图表格式导出。\n    - [x] Drawio\n    - [x] Excalidraw\n  - [x] 模板创建。支持创建模板，并基于 Graph MIR 进行转换，转换成其它图表格式。\n  - [ ] 多样化图形布局。支持 Dagre、ELK、Cola 等布局。\n  - [x] Dagre\n    - [ ] replace Grapvhiz to WASM\n  - [ ] 手绘风格。\n    - [x] Rough.js sample\n- [x] Collaboration\n  - [x] Server\n  - [x] Protocol\n    - [x] CRDT\n  - [x] Editor\n- [ ] DSL\n  - [x] FKL Syntax\n  - [x] FKL Parser\n  - [ ] FKL LSP\n- [ ] Editor\n  - [x] Dot Language\n  - [ ] Fkl Language \n\n## DSL Samples\n\n```fkl\nContextMap TicketBooking {\n  Reservation \u003c-\u003e TicketContext;\n}\n\nContext TicketContext {\n  Aggregate Ticket, Reservation;\n}\n\nEntity Ticket {\n  Struct {\n    seat: String;\n  }\n}\n\n// binding;\nimpl CinemaCreated {\n  endpoint {\n    GET \"/book/{id}\";\n    authorization: Basic admin admin;\n    response: Cinema;\n  }\n\n  flow {\n    via UserRepository::getUser receive x: User;\n    via Kafak send User to \"user.create\";\n  }\n}\n```\n\n\n  \n## Demos\n\nTry Online demo: [https://online.feakin.com/](https://online.feakin.com/) Or install `@feakin/cli` for diagrams converter: \n\n```shell\nnpm install -g @feakin/cli\n\nfeakin --input software-development.md.drawio --output sd.excalidraw\n```\n\n## Todos\n\n- [ ] Render\n  - [x] Layout Engine (TODO: split to standalone module)\n    - [x] [dagre](https://github.com/dagrejs/dagre)\n    - [ ] [ELK](https://github.com/kieler/elkjs)\n    - [ ] [cola.js](https://ialab.it.monash.edu/webcola/)\n  - [x] Canvas\n    - [x] [Konva.js](https://github.com/konvajs/konva), react: [react-konva](https://github.com/konvajs/react-konva)\n  - [x] Style\n    - [x] [roughjs](https://github.com/rough-stuff/rough): sketchy, hand-drawn-like, style\n- [ ] Editor\n  - [x] text Editor with Monaco Editor\n  - [ ] interactive Editor with Graphical Editor\n- [x] Parser\n  - [x] [Jison](https://github.com/zaach/jison) with Mermaid\n- [ ] collaboration\n  - [ ] [Rope Architecture Model](https://blog.jetbrains.com/zh-hans/fleet/2022/02/fleet-below-deck-part-ii-breaking-down-the-editor/)\n    - [Rope](https://github.com/component/rope)\n  - [ ] [State Management](https://blog.jetbrains.com/zh-hans/fleet/2022/06/fleet-below-deck-part-iii-state-management/)\n- [x] CLI\n  - [x] upgrade publish script\n- [ ] Architecture Features\n  - [x] Playground: [https://online.feakin.com/](https://online.feakin.com/)\n  - [ ] [ComponentLess](https://componentless.com/) architecture\n    - [ ] WebComponent, like `\u003cfeakin data=\"\" layout=\"\" import=\"\" import-type=\"\"\u003e\u003c/feakin\u003e`\n  - [ ] Templates\n    - [ ] DDD ?\n    - [ ] Layered Architecture\n    - [ ] Test Pyramid\n  - [x] Export and Import\n    - [x] MxGraph\n    - [x] Excalidraw\n    - [ ] PlantUML\n- [ ] Libraries\n  - [ ] compatible Excalidraw libraries : https://libraries.excalidraw.com/?theme=light\u0026sort=default\n\n## Setup\n\nWe use nx.js for mono-repo architecture.\n\n1. install\n\n```shell\nnpm install --legacy-peer-deps\n```\n\nNote: nx.js use Craco, which will need `--legacy-peer-deps`.\n\n2. development exporter, can just run by tests\n\n## License\n\n- Flow parser based on [mermaid.js](https://github.com/mermaid-js/)\n- Excalidraw's type based on [excalidraw](https://github.com/excalidraw/excalidraw)\n\n@2022 Thoughtworks This code is distributed under the MPL license. See `LICENSE` in this directory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffeakin%2Ffeakin-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffeakin%2Ffeakin-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffeakin%2Ffeakin-web/lists"}