okooooooo/aitu
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: 将项目名称从drawnix更改为aitu并更新相关文档

Browse Source 
更新package.json中的项目名称和相关信息
修改README和CLAUDE.md中的项目描述和链接
统一代码和文档中的项目引用为aitu
This commit is contained in:
liquid committed 2025-09-08 00:27:11 +08:00
1 parent da49612d4a
commit d059279078
5 files changed
+66 -55
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CLAUDE.md
+3 -3
View File
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
## Project Overview
Drawnix is an open-source whiteboard application built on the Plait framework. It supports mind maps, flowcharts, freehand drawing, image insertion, and AI-powered content generation. The project uses a plugin architecture with React components and is built with Nx as the monorepo management tool.
Aitu (爱图) is an open-source whiteboard application built on the Plait framework. It supports mind maps, flowcharts, freehand drawing, image insertion, and AI-powered content generation. The project uses a plugin architecture with React components and is built with Nx as the monorepo management tool.
## Development Commands
@@ -18,7 +18,7 @@ Type check: `nx typecheck <project-name>`
## Architecture
### Monorepo Structure
- `apps/web/` - Main web application (drawnix.com)
- `apps/web/` - Main web application (aitu.app)
- `packages/drawnix/` - Core whiteboard library with UI components and plugins
- `packages/react-board/` - React wrapper for Plait board functionality
- `packages/react-text/` - Text rendering and editing components
@@ -27,7 +27,7 @@ Type check: `nx typecheck <project-name>`
- popup-toolbar
### Core Components
- **Drawnix Component** (`packages/drawnix/src/drawnix.tsx`) - Main application wrapper with state management and plugin composition
- **Aitu Component** (`packages/drawnix/src/drawnix.tsx`) - Main application wrapper with state management and plugin composition
- **Plugin System** - Extensible architecture with plugins for freehand drawing, mind maps, hotkeys, text editing, and image handling
- **Toolbar System** - Modular toolbars for creation, zoom, themes, and context-sensitive popup tools
- **TTD Dialog** - Text-to-diagram conversion supporting Markdown and Mermaid syntax
README.md
+25 -25
View File
@@ -7,7 +7,7 @@
</p>
<div align="center">
<h2>
AI图片视频创作（SaaS），一体化白板，包含思维导图、流程图、自由画等
爱图 - AI图片视频创作（SaaS），一体化白板，包含思维导图、流程图、自由画等
<br />
</h2>
</div>
@@ -57,33 +57,33 @@
## 关于名称
***Drawnix*** ，源于绘画( ***Draw*** )与凤凰( ***Phoenix*** )的灵感交织。
***爱图(Aitu)*** ，源于对创作的热爱与图形表达的追求。
凤凰象征着生生不息的创造力，而 *Draw* 代表着人类最原始的表达方式。在这里，每一次创作都是一次艺术的涅槃，每一笔绘画都是灵感的重生。
*爱* 代表着对创作的热情与专注，*图* 象征着视觉表达的无限可能。在这里，每一次创作都是对美好的追求，每一笔绘画都是想象力的延伸。
创意如同凤凰，浴火方能重生，而 ***Drawnix*** 要做技术与创意之火的守护者。
创意源于内心的热爱，而 ***爱图(Aitu)*** 致力于成为每个创作者的得力助手。
*Draw Beyond, Rise Above.*
*爱创作，图未来。*
## 与 Plait 画图框架
*Drawnix* 的定位是一个开箱即用、开源、免费的工具产品，它的底层是 *Plait* 框架，*Plait* 是我司开源的一款画图框架，代表着公司在知识库产品([PingCode Wiki](https://pingcode.com/product/wiki?utm_source=drawnix))上的重要技术沉淀。
*爱图(Aitu)* 的定位是一个开箱即用、开源、免费的工具产品，它的底层是 *Plait* 框架，*Plait* 是开源的画图框架，代表着在知识可视化产品上的重要技术积累。
Drawnix 是插件架构，与前面说到开源工具比技术架构更复杂一些，但是插件架构也有优势，比如能够支持多种 UI 框架（*Angular、React*），能够集成不同富文本框架（当前仅支持 *Slate* 框架），在开发上可以很好的实现业务的分层，开发各种细粒度的可复用插件，可以扩展更多的画板的应用场景。
爱图 采用插件架构，虽然技术架构相对复杂，但插件架构也有其优势，比如能够支持多种 UI 框架（*Angular、React*），能够集成不同富文本框架（当前仅支持 *Slate* 框架），在开发上可以很好的实现业务的分层，开发各种细粒度的可复用插件，可以扩展更多的画板的应用场景。
## 仓储结构
```
drawnix/
aitu/
├── apps/
│ ├── web # drawnix.com
│ ├── web # 爱图 Web 应用
│ │ └── index.html # HTML
├── dist/ # 构建产物
├── packages/
│ └── drawnix/ # 白板应用
│ └── drawnix/ # 白板应用核心
│ └── react-board/ # 白板 React 视图层
│ └── react-text/ # 文本渲染模块
├── package.json
@@ -95,15 +95,15 @@ drawnix/
## 应用
[*https://drawnix.com*](https://drawnix.com) 是 *drawnix* 的最小化应用。
[*https://aitu.app*](https://aitu.app) 是 *爱图* 的在线应用。
近期会高频迭代 drawnix.com，直到发布 *Dawn（破晓）* 版本。
近期会高频迭代应用功能，持续优化用户体验。
## 🚀 快速开始
### 在线体验
直接访问 [drawnix.com](https://drawnix.com) 立即开始使用，无需安装任何软件。
直接访问 [aitu.app](https://aitu.app) 立即开始使用，无需安装任何软件。
### 本地开发
@@ -115,8 +115,8 @@ drawnix/
```bash
# 克隆仓库
git clone https://github.com/plait-board/drawnix.git
cd drawnix
git clone https://github.com/ljquan/aitu.git
cd aitu
# 安装依赖
npm install
@@ -193,10 +193,10 @@ nx test react-board
### 🔧 插件开发
Drawnix 基于插件架构，支持自定义扩展：
爱图 基于插件架构，支持自定义扩展：
```typescript
import { withFreehand, withMind, withDraw } from '@drawnix/core';
import { withFreehand, withMind, withDraw } from '@aitu/core';
// 创建带有特定插件的编辑器实例
const editor = withFreehand(
@@ -210,10 +210,10 @@ const editor = withFreehand(
```bash
# 拉取镜像
docker pull pubuzhixing/drawnix:latest
docker pull ljquan/aitu:latest
# 运行容器
docker run -d -p 8080:80 pubuzhixing/drawnix:latest
docker run -d -p 8080:80 ljquan/aitu:latest
```
访问 `http://localhost:8080` 即可使用。
@@ -277,7 +277,7 @@ packages/
### 贡献方式
#### 🐛 报告问题
- 使用 [GitHub Issues](https://github.com/plait-board/drawnix/issues) 报告 Bug
- 使用 [GitHub Issues](https://github.com/ljquan/aitu/issues) 报告 Bug
- 请提供详细的重现步骤和环境信息
- 附上截图或录屏会更有帮助
@@ -290,7 +290,7 @@ packages/
1. **Fork 项目**
```bash
git clone https://github.com/your-username/drawnix.git
git clone https://github.com/your-username/aitu.git
```
2. **创建功能分支**
@@ -369,8 +369,8 @@ nx lint drawnix
### 获取帮助
- 📖 查看 [文档](./docs/)
- 💬 提交 [Issue](https://github.com/plait-board/drawnix/issues)
- 🗣️ 参与 [Discussions](https://github.com/plait-board/drawnix/discussions)
- 💬 提交 [Issue](https://github.com/ljquan/aitu/issues)
- 🗣️ 参与 [Discussions](https://github.com/ljquan/aitu/discussions)
## 🗺️ 路线图
@@ -393,7 +393,7 @@ nx lint drawnix
- 📅 API 开放平台
- 📅 桌面客户端
发布计划请关注 [Releases](https://github.com/plait-board/drawnix/releases) 页面。
发布计划请关注 [Releases](https://github.com/ljquan/aitu/releases) 页面。
## 感谢支持
@@ -407,4 +407,4 @@ nx lint drawnix
## License
[MIT License](https://github.com/plait-board/drawnix/blob/master/LICENSE)
[MIT License](https://github.com/ljquan/aitu/blob/master/LICENSE)
README_en.md
+25 -25
View File
@@ -7,7 +7,7 @@
</p>
<div align="center">
<h2>
Open-source whiteboard tool (SaaS), an all-in-one collaborative canvas that includes mind mapping, flowcharts, freehand and more.
Aitu - Open-source whiteboard tool (SaaS), an all-in-one collaborative canvas that includes mind mapping, flowcharts, freehand and more.
<br />
</h2>
</div>
@@ -36,7 +36,7 @@
<a href="https://trendshift.io/repositories/13979" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13979" alt="plait-board%2Fdrawnix | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
</div>
[*中文*](https://github.com/plait-board/drawnix/blob/develop/README.md)
[*中文*](https://github.com/ljquan/aitu/blob/develop/README.md)
## Features
@@ -57,27 +57,27 @@
## About the Name
***Drawnix*** is born from the interweaving of ***Draw*** and ***Phoenix***, a fusion of artistic inspiration.
***Aitu*** is born from the love of creation and the pursuit of visual expression.
The *Phoenix* symbolizes endless creativity, while *Draw* represents humanity's most fundamental form of expression. Here, each creation is an artistic rebirth, every stroke a renaissance of inspiration.
*Ai* represents passion and dedication to creation, while *tu* symbolizes the infinite possibilities of visual expression. Here, each creation is a pursuit of beauty, every stroke an extension of imagination.
Like a Phoenix, creativity must rise from the flames to be reborn, and ***Drawnix*** stands as the guardian of both technical and creative fire.
Creativity stems from inner love, and ***Aitu*** is committed to being a powerful assistant for every creator.
*Draw Beyond, Rise Above.*
*Love Creation, Visualize the Future.*
## About Plait Drawing Framework
*Drawnix* is positioned as an out-of-the-box, *open-source*, and free tool product. It is built on top of the *Plait* framework, which is our company's *open-source* drawing framework representing significant technical accumulation in knowledge base products([PingCode Wiki](https://pingcode.com/product/wiki?utm_source=drawnix)).
*Aitu* is positioned as an out-of-the-box, *open-source*, and free tool product. It is built on top of the *Plait* framework, which is an *open-source* drawing framework representing significant technical accumulation in knowledge visualization products.
*Drawnix* uses a *plugin architecture*, which is technically more complex than the previously mentioned *open-source* tools. However, this *plugin architecture* has its advantages: it supports multiple *UI frameworks* (*Angular*, *React*), integrates with different *rich text frameworks* (currently only supporting *Slate* framework), enables better business layer separation in development, allows development of various fine-grained reusable plugins, and can expand to more whiteboard application scenarios.
*Aitu* uses a *plugin architecture*, which is technically more complex than traditional *open-source* tools. However, this *plugin architecture* has its advantages: it supports multiple *UI frameworks* (*Angular*, *React*), integrates with different *rich text frameworks* (currently only supporting *Slate* framework), enables better business layer separation in development, allows development of various fine-grained reusable plugins, and can expand to more whiteboard application scenarios.
## Repository Structure
```
drawnix/
aitu/
├── apps/
│ ├── web # drawnix.com
│ ├── web # Aitu web application
│ │ └── index.html # HTML
├── dist/ # Build artifacts
├── packages/
@@ -93,15 +93,15 @@ drawnix/
## Try It Out
*https://drawnix.com* is the minimal application of *drawnix*.
*https://aitu.app* is the online application of *Aitu*.
I will be iterating frequently on *drawnix.com* until the release of the *Dawn* version.
We will be iterating frequently on application features to continuously optimize user experience.
## 🚀 Quick Start
### Online Experience
Visit [drawnix.com](https://drawnix.com) directly to start using it immediately, no installation required.
Visit [aitu.app](https://aitu.app) directly to start using it immediately, no installation required.
### Local Development
@@ -113,8 +113,8 @@ Visit [drawnix.com](https://drawnix.com) directly to start using it immediately,
```bash
# Clone the repository
git clone https://github.com/plait-board/drawnix.git
cd drawnix
git clone https://github.com/ljquan/aitu.git
cd aitu
# Install dependencies
npm install
@@ -190,10 +190,10 @@ nx test react-board
### 🔧 Plugin Development
Drawnix is built on a plugin architecture and supports custom extensions:
Aitu is built on a plugin architecture and supports custom extensions:
```typescript
import { withFreehand, withMind, withDraw } from '@drawnix/core';
import { withFreehand, withMind, withDraw } from '@aitu/core';
// Create editor instance with specific plugins
const editor = withFreehand(
@@ -207,10 +207,10 @@ const editor = withFreehand(
```bash
# Pull image
docker pull pubuzhixing/drawnix:latest
docker pull ljquan/aitu:latest
# Run container
docker run -d -p 8080:80 pubuzhixing/drawnix:latest
docker run -d -p 8080:80 ljquan/aitu:latest
```
Visit `http://localhost:8080` to use.
@@ -273,7 +273,7 @@ We welcome and appreciate any form of contribution!
### Ways to Contribute
#### 🐛 Report Issues
- Use [GitHub Issues](https://github.com/plait-board/drawnix/issues) to report bugs
- Use [GitHub Issues](https://github.com/ljquan/aitu/issues) to report bugs
- Please provide detailed reproduction steps and environment information
- Screenshots or screen recordings would be very helpful
@@ -286,7 +286,7 @@ We welcome and appreciate any form of contribution!
1. **Fork the Project**
```bash
git clone https://github.com/your-username/drawnix.git
git clone https://github.com/your-username/aitu.git
```
2. **Create Feature Branch**
@@ -365,8 +365,8 @@ nx lint drawnix
### Getting Help
- 📖 Check [Documentation](./docs/)
- 💬 Submit [Issue](https://github.com/plait-board/drawnix/issues)
- 🗣️ Join [Discussions](https://github.com/plait-board/drawnix/discussions)
- 💬 Submit [Issue](https://github.com/ljquan/aitu/issues)
- 🗣️ Join [Discussions](https://github.com/ljquan/aitu/discussions)
## 🗺️ Roadmap
@@ -389,7 +389,7 @@ nx lint drawnix
- 📅 Open API platform
- 📅 Desktop client
Follow [Releases](https://github.com/plait-board/drawnix/releases) for release plans.
Follow [Releases](https://github.com/ljquan/aitu/releases) for release plans.
## Thank you for supporting
@@ -403,4 +403,4 @@ Special thanks to the company for its strong support for open source projects, a
## License
[MIT License](https://github.com/plait-board/drawnix/blob/master/LICENSE)
[MIT License](https://github.com/ljquan/aitu/blob/master/LICENSE)
package.json
+12 -1
View File
@@ -1,7 +1,18 @@
{
"name": "@drawnix/source",
"name": "@aitu/source",
"version": "0.0.10",
"license": "MIT",
"description": "Aitu - An open-source whiteboard tool with AI-powered image/video creation, mind mapping, flowcharts, and freehand drawing",
"homepage": "https://aitu.chat",
"repository": {
"type": "git",
"url": "https://github.com/ljquan/aitu.git"
},
"bugs": {
"url": "https://github.com/ljquan/aitu/issues"
},
"keywords": ["whiteboard", "mindmap", "flowchart", "drawing", "AI", "collaboration", "visualization"],
"author": "ljquan",
"scripts": {
"start": "nx serve web --host=0.0.0.0",
"build": "node scripts/update-version.js && nx run-many -t=build",
packages/drawnix/package.json
+1 -1
View File
@@ -1,5 +1,5 @@
{
"name": "@drawnix/drawnix",
"name": "@aitu/drawnix",
"version": "0.2.1",
"main": "./index.js",
"types": "./index.d.ts",