Files
TrueGrowth/README_en.md

88 lines
3.0 KiB
Markdown

<div align="center">
<h1>TrueGrowth (TrueGrowth.ai)</h1>
<h3>Canvas-first AI Application Platform</h3>
<p>Connect models, tools, assets, and knowledge flows so AI work keeps running in one workspace.</p>
</div>
[中文 README](./README.md)
## Product Showcase
| Split Images | Flowcharts | Mind Maps |
| --- | --- | --- |
| ![](./apps/web/public/product_showcase/九宫格拆图.gif) | ![](./apps/web/public/product_showcase/流程图.gif) | ![](./apps/web/public/product_showcase/思维导图.gif) |
| Semantic image splitting | Semantic flowcharts | Semantic mind maps |
## Platform Capabilities
- **AI generation and routing**: images, video, audio, text, and Agent flows from one workspace.
- **Canvas workspace**: AI tasks, assets, frames, tool windows, and knowledge-base content share the same surface.
- **Task and asset management**: queues, media library, unified cache, and history make outputs reusable.
- **Toolbox and extensions**: internal React tools, iframe tools, Skill/Agent modules, and plugin runtime support.
- **PPT and content workflows**: frame slideshows, PPT export, Markdown/Mermaid conversion, and media editing.
## Local Development
### Requirements
- Node.js 20+
- pnpm 10.21.0, preferably via Corepack
### Install and Run
```bash
corepack enable pnpm
pnpm install
pnpm start
```
Open `http://localhost:7200` after the dev server starts.
### Common Commands
```bash
pnpm start # Start Web dev server
pnpm build:web # Build the Web app
pnpm build # Build the workspace
pnpm check # typecheck + lint
pnpm test # Run unit tests
pnpm e2e:smoke # Run smoke E2E tests
pnpm check:cycles # Check circular dependencies
pnpm manual:build # Generate user manual
```
## Deployment
The repository keeps several supported deployment paths:
- Vercel / Netlify: use your own repository config or the included static hosting config.
- Docker: build the static-site image with the root `Dockerfile`.
- Hybrid CDN + self-hosting: see [NPM CDN Deploy](./docs/NPM_CDN_DEPLOY.md) and [CDN Deployment](./docs/CDN_DEPLOYMENT.md).
## Repository Structure
```text
TrueGrowth/
├── apps/
│ ├── web/ # TrueGrowth Web app and Service Worker
│ └── web-e2e/ # Playwright E2E and manual generation
├── packages/
│ ├── drawnix/ # Canvas workspace core
│ ├── react-board/ # Plait React board adapter
│ ├── react-text/ # Text rendering components
│ └── utils/ # Shared utilities and workflow parsing
├── docs/ # Current development documentation
├── openspec/ # Requirements and change proposals
└── scripts/ # Build, release, manual, and deploy scripts
```
## Documentation
- [Development docs](./docs/README.md)
- [Contributing guide](./CONTRIBUTING.md)
- [OpenSpec instructions](./openspec/AGENTS.md)
## License
MIT