diff --git a/frontend/README.md b/frontend/README.md index ff5e77dd..ed121780 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1 +1,122 @@ -TODO: something here +# Coze Studio Frontend + +This is the frontend project of Coze Studio, an AI Agent development platform built with monorepo architecture, based on React 18 and modern frontend technology stack. + +## ๐Ÿ—๏ธ Project Architecture + +### Core Technology Stack +- **Framework**: React 18 + TypeScript +- **Build Tool**: Rsbuild +- **Package Manager**: Rush + PNPM +- **Routing**: React Router v6 +- **State Management**: Zustand +- **UI Components**: @coze-arch/coze-design +- **Internationalization**: @coze-arch/i18n + +### Directory Structure + +``` +frontend/ +โ”œโ”€โ”€ apps/ # Application layer +โ”‚ โ””โ”€โ”€ coze-studio/ # Main application +โ”œโ”€โ”€ packages/ # Core packages +โ”‚ โ”œโ”€โ”€ agent-ide/ # AI Agent development environment +โ”‚ โ”œโ”€โ”€ arch/ # Architecture infrastructure +โ”‚ โ”œโ”€โ”€ common/ # Common components and utilities +โ”‚ โ”œโ”€โ”€ components/ # UI component library +โ”‚ โ”œโ”€โ”€ data/ # Data layer +โ”‚ โ”œโ”€โ”€ devops/ # DevOps tools +โ”‚ โ”œโ”€โ”€ foundation/ # Foundation infrastructure +โ”‚ โ”œโ”€โ”€ project-ide/ # Project development environment +โ”‚ โ”œโ”€โ”€ studio/ # Studio core features +โ”‚ โ””โ”€โ”€ workflow/ # Workflow engine +โ”œโ”€โ”€ config/ # Configuration files +โ”‚ โ”œโ”€โ”€ eslint-config/ # ESLint configuration +โ”‚ โ”œโ”€โ”€ rsbuild-config/ # Rsbuild build configuration +โ”‚ โ”œโ”€โ”€ ts-config/ # TypeScript configuration +โ”‚ โ”œโ”€โ”€ postcss-config/ # PostCSS configuration +โ”‚ โ”œโ”€โ”€ stylelint-config/ # Stylelint configuration +โ”‚ โ”œโ”€โ”€ tailwind-config/ # Tailwind CSS configuration +โ”‚ โ””โ”€โ”€ vitest-config/ # Vitest testing configuration +โ””โ”€โ”€ infra/ # Infrastructure tools + โ”œโ”€โ”€ idl/ # Interface Definition Language tools + โ”œโ”€โ”€ plugins/ # Build plugins + โ””โ”€โ”€ utils/ # Utility libraries +``` + +## ๐Ÿš€ Quick Start + +### Prerequisites +- Node.js >= 21 +- PNPM 8.15.8 +- Rush 5.147.1 + +### Install Dependencies +```bash +# Run in project root directory +rush install +# update +rush update +``` + +### Development Mode +```bash +# Start development server +cd apps/coze-studio +npm run dev +# or use rushx +rushx dev +``` + +### Production Build +```bash +# Build application +cd apps/coze-studio +npm run build +# or use rushx +rushx build +``` + +## ๐Ÿ“ฆ Core Modules + +### Agent IDE +- **agent-ide**: AI Agent integrated development environment +- **prompt**: Prompt editor +- **tool**: Tool configuration management +- **workflow**: Workflow integration + +### Architecture Layer (arch) +- **bot-api**: API interface layer +- **bot-hooks**: React Hooks library +- **foundation-sdk**: Foundation SDK +- **i18n**: Internationalization support +- **bot-flags**: Feature flags management +- **web-context**: Web context utilities + +### Workflow Engine (workflow) +- **fabric-canvas**: Canvas rendering engine +- **nodes**: Node component library +- **sdk**: Workflow SDK +- **playground**: Debug runtime environment + +### Data Layer (data) +- **knowledge**: Knowledge base management +- **memory**: Memory system +- **common**: Common data processing + +## ๐Ÿ”ง Development Standards + +### Code Quality +- Code formatting with ESLint + Prettier +- TypeScript strict mode +- Unit test coverage requirements +- Team-based tier management (level-1 to level-4) + +### Team Collaboration +- Rush-based monorepo management +- Workspace dependency management +- Unified build and release process + +## ๐Ÿ“„ License + +Apache License 2.0 \ No newline at end of file diff --git a/frontend/rushx-config.json b/frontend/rushx-config.json index c0f11e8d..ccc73afb 100644 --- a/frontend/rushx-config.json +++ b/frontend/rushx-config.json @@ -1,26 +1,15 @@ -// ๆ‰€ๆœ‰ๅฃฐๆ˜Žๅœจ rush.json ไธญ็š„ๅŒ…๏ผŒ้œ€่ฆๅœจ tags ้…็ฝฎไธญ๏ผŒๆทปๅŠ ๅ›ข้˜Ÿๅ’Œๅˆ†็บงๆ่ฟฐใ€‚ๆ่ฟฐ็š„ๆžšไธพๅฆ‚ไธ‹ { "$schema": "./rushx-config.schema.json", - // ๅ›ข้˜Ÿๆƒ…ๅ†ต๏ผŒๅฏไปฅ่‡ช่กŒๆทปๅŠ  "team": [ - // ่ดŸ่ดฃไบบ๏ผš@xukai.luics "team-automation", - // ่ดŸ่ดฃไบบ๏ผš@changyang.liu "team-builder", - // ่ดŸ่ดฃไบบ๏ผš@linyibin "team-community", - // ่ดŸ่ดฃไบบ๏ผš@sunshengda "team-data", - // ่ดŸ่ดฃไบบ๏ผš@xuyuantong, @dingquan "team-devops", - // ่ดŸ่ดฃไบบ๏ผš@fanwenjie.fe "team-arch", - // ่ดŸ่ดฃไบบ๏ผš@sunkuo "team-studio", "team-qa" ], - // ๅ…จ้ƒจๅˆ†็บงๅŒ… - // delete ๅฐ†่ขซๅˆ ้™คๅŒ…๏ผŒๆš‚ไธๅšๅˆ†็บง "level": ["level-1", "level-2", "level-3", "level-4"], "codecov": { "coverage": 20, @@ -33,7 +22,6 @@ "coverage": 30, "incrementCoverage": 60 }, - // ๅŽ็ปญ้€ๆญฅๆๅ‡่ฟ™ไธช level ็š„ๅขž้‡่ฆ†็›–็އ "level-3": { "coverage": 0, "incrementCoverage": 0