Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.43 KB

README.md

File metadata and controls

78 lines (51 loc) · 2.43 KB
Raw

Suika Graphics Editor, an open-source vector graphics editor based on Canvas, similar to Figma.

suika 图形编辑器，一款开源的基于 Canvas 实现的矢量图形编辑器，类似 Figma。

English | 中文

Experience

Screenshot

Features

  1. Creation and editing of graphics, including: rounded rectangle, ellipse, line, path, text, polygon, star;
  2. Path editing using the pen tool, adjusting control points;
  3. Support tools: selection tool, graphics drawing tools, image tool, pen tool, canvas tool, hand tool;
  4. Infinite canvas, with zoom and pan capabilities;
  5. History, with undo and redo;
  6. i18n;
  7. Snap support, currently supports pixel grid snap and graphics guide snap;
  8. Keyboard shortcuts;
  9. Copy and paste, supports cross-canvas copy and paste, alignment, and arrangement;
  10. Layers panel, properties panel;
  11. Group, Frame;
  12. Multi-user collaborative editing (requires backend implementation);
  13. Ruler;
  14. Import and export JSON data;
  15. User settings;

Next Steps

  • Improve path editing operations;
  • Components;

Documentation

WIP.

Environment Dependencies

To run the project, you need to install Node.js (it is recommended to use the LTS version from the official website), then use Node.js to install the PNPM package manager:

npm install -g pnpm

Install

pnpm install

Dev

pnpm run dev

Build

pnpm build

The target output folder is packages/suika/build.

Icon

figma design

About Multi-User Collaboration

The frontend implementation logic for collaboration is located in the @suika/suika-multiplayer package. This package copies @suika/suika (pure client-side) and adds multi-user collaboration logic, such as multiple cursors, and calls some interfaces, like getting the drawing name and current user information.

Multi-user collaboration is implemented using yjs and the hocuspocus library (a further wrapper around yjs).

If you want to implement multi-user collaboration, you need to implement backend RESTful API services that this package uses, and provide WebSocket services based on hocuspocus.

Additionally, you need to implement a frontend workspace project to manage drawings, supporting login, registration, creating drawings, opening drawings, deleting drawings, and authorization.