drawnix README

The project's README from github.com/plait-board/drawnix. As one markdown file: README.md.

Drawnix logo and name

开源白板工具(SaaS),一体化白板,包含思维导图、流程图、自由画等

Product showcase

All in one 白板,思维导图、流程图、自由画等

Featured|HelloGitHub

plait-board%2Fdrawnix | Trendshift


AtomGit G-Star

English README

特性

关于名称

Drawnix ,源于绘画( Draw )与凤凰( Phoenix )的灵感交织。

凤凰象征着生生不息的创造力,而 Draw 代表着人类最原始的表达方式。在这里,每一次创作都是一次艺术的涅槃,每一笔绘画都是灵感的重生。

创意如同凤凰,浴火方能重生,而 Drawnix 要做技术与创意之火的守护者。

Draw Beyond, Rise Above.

与 Plait 画图框架

Drawnix 的定位是一个开箱即用、开源、免费的工具产品,它的底层是 Plait 框架,Plait 是我司开源的一款画图框架,代表着公司在知识库产品(PingCode Wiki)上的重要技术沉淀。

Drawnix 是插件架构,与前面说到开源工具比技术架构更复杂一些,但是插件架构也有优势,比如能够支持多种 UI 框架(Angular、React),能够集成不同富文本框架(当前仅支持 Slate 框架),在开发上可以很好的实现业务的分层,开发各种细粒度的可复用插件,可以扩展更多的画板的应用场景。

仓储结构

drawnix/
├── apps/
│   ├── web                   # drawnix.com
│   │    └── index.html       # HTML
├── dist/                     # 构建产物
├── packages/
│   └── drawnix/              # 白板应用
│   └── react-board/          # 白板 React 视图层
│   └── react-text/           # 文本渲染模块
├── package.json
├── ...
└── README.md
└── README_en.md

应用

https://drawnix.com 是 drawnix 的最小化应用。

近期会高频迭代 drawnix.com,直到发布 Dawn(破晓) 版本。

开发

npm install

npm run start

Docker

docker pull pubuzhixing/drawnix:latest

依赖

贡献

欢迎任何形式的贡献:

提交 Issue 或 Pull Request 前,请先阅读 贡献指南。

感谢支持

特别感谢公司对开源项目的大力支持,也感谢为本项目贡献代码、提供建议的朋友。

PingCode

License

MIT License

drawnix (plait-board/drawnix)

Searching Database…

14.9K ·GitHub
What is this?Drawnix is a free, open-source all-in-one whiteboard tool that combines mind mapping, flowcharts, and freehand drawing on a single infinite canvas.
Is this a standalone app or a framework?Drawnix is a ready-to-use web app built on top of 'Plait', a separate open-source diagramming framework from the same team. Drawnix uses a plugin architecture, so it can in theory support multiple UI frameworks like Angular and React.
How do I get it running?You can clone the repo and run it with Nx ('nx serve web --host=0.0.0.0' for dev, 'nx build web' to build), or deploy it with the included Docker setup; a hosted version is also being iterated on at drawnix.com.
Do I need Node.js or any build tools first?Yes, it's an Nx-based TypeScript monorepo, so you need Node.js to run the 'nx serve'/'nx build' commands; Docker is available as an alternative to a local Node setup.
Any limitations I should know about?The plugin architecture currently only integrates one rich-text framework (Slate), and the public drawnix.com site is still being iterated on frequently ahead of its first 'Dawn' release.
Why is the project called Drawnix?The name blends 'Draw' with 'Phoenix', symbolizing creativity reborn through drawing, much like a phoenix rising from fire.
Can it turn Markdown or Mermaid syntax into diagrams automatically?Yes, Drawnix can convert Mermaid syntax into flowcharts and plain Markdown text into mind maps.
What formats can I export my whiteboard to?You can export a board as a PNG image or as a JSON file using the .drawnix extension.
Does Drawnix work well on phones and tablets?Yes, the interface is adapted for mobile devices as well as desktop browsers.
Size
1.9 MB
Stars
14.9K
Age
2y
Commits · 90 Days