KittyCAD 模型应用开发指南

KittyCAD 模型应用开发指南

modeling-app The KittyCAD modeling app. 项目地址: https://gitcode.com/gh_mirrors/mo/modeling-app

KittyCAD 模型应用是一款旨在重新定义现代建模体验的CAD软件，它将可读的人类语言代码融入设计过程，并充分利用GPU技术来提升渲染性能。以下是该开源项目的基本架构解析和关键文件介绍。

1. 项目目录结构及介绍

KittyCAD 模型应用的目录组织是典型的现代前端项目布局，结合了Rust编译的WASM（WebAssembly）组件和JavaScript前端技术。下面是核心目录结构和关键路径的简要说明：

• assets: 存放静态资源，如图片、图标等。
• docs/kcl: KCL（可能是一种特定于KittyCAD的语言或配置）相关文档。
• e2e/playwright: 端到端测试脚本，利用Playwright进行自动化测试。
• openapi: 可能包含API接口的规范文件。
• packages/codemirror-lsp-client: 一个定制化的CodeMirror插件，支持语言服务器协议（LSP），用于代码编辑器中的智能提示。
• public: 静态资源目录，直接服务给最终用户的文件，包括HTML入口文件(index.html)。
• src: 应用的核心源码目录，包含UI逻辑、业务逻辑等。
  • codespellrc, eslintignore, eslintrc, gitignore, nvmrc, ...: 开发工具配置文件。
  • tsconfig.json, vite-env.d.ts: TypeScript和Vite的相关配置。
  • 各个功能子目录：如UI相关的React组件、网络请求处理、状态管理(XState)等。
• scripts: 包含各种辅助脚本，如构建、发布流程。
• package.json: Node.js项目的主要配置文件，包含了依赖项、脚本命令等。
• LICENSE: 许可证文件，该项目遵循MIT许可证。
• README.md: 项目介绍和快速入门指南。

2. 项目的启动文件介绍

项目的启动主要通过Node.js环境和Vite、Webpack等构建工具进行。核心启动逻辑不在单一的“启动文件”中，而是分散在npm/yarn脚本命令中，特别是package.json内的脚本部分。常见的启动命令有：

• yarn start: 启动开发服务器，预览应用程序，适合开发者调试使用。
• 特定于构建和运行WASM的命令，比如yarn build:wasm-dev用于构建开发版本的WASM文件，这对于涉及Rust和WASM的部分尤为重要。

3. 项目的配置文件介绍

主要配置文件:

• package.json: 包含项目信息、脚本命令、依赖列表等，是项目启动和构建流程的控制中心。
• tsconfig.json: TypeScript编译器的配置文件，指定了类型检查、编译选项等。
• vite.config.js 或其他Vite配置文件: Vite构建工具的配置，影响开发模式下的服务器设置、优化策略等。
• 环境配置文件 (env/development, env/production): 区分开发与生产环境的变量设置，确保不同环境下应用正确配置。
• .gitignore: 控制哪些文件不应被Git追踪，避免不必要的文件提交到版本控制系统中。

特别地，对于与特定技术栈相关的配置（如CodeMirror的LSP配置、状态管理配置等），它们通常位于对应的包内或与之紧密相关的目录下，体现高度模块化的设计思想。

此文档提供了一个概览，深入理解每个部分的具体细节需参考项目中的具体文档和注释。

modeling-app The KittyCAD modeling app. 项目地址: https://gitcode.com/gh_mirrors/mo/modeling-app