CADmium 开源项目安装与使用指南

2024-10-10 20:12:22作者：晏闻田Solitary

1. 项目目录结构及介绍

CADmium 是一个基于浏览器运行的 CAD 程序，其项目结构精心设计以支持模块化和高效的开发流程。以下是主要的目录结构及其简介：

CADmium/
|-- applications                 # 应用程序相关代码，包括前端UI部分
|   |-- web                       # 使用SvelteKit构建的Web应用
|-- packages                      # 包含核心库和其他组件
|   |-- cadmium                  # Rust编写的CAD功能库
|   |-- examples                  # 示例代码，展示Rust库的使用方法
|-- git-blame-ignore-revs         # Git配置文件，用于在git blame时忽略特定修订
|-- github                        # 可能是与GitHub工作流相关的配置
|-- npmrc                         # npm配置文件
|-- prettierignore                # Prettier忽略的文件列表
|-- Cargo.lock                    # Rust依赖锁定文件
|-- Cargo.toml                    # Rust项目的配置文件
|-- LICENSE.md                    # 许可证文件，采用Elastic License 2.0
|-- README.md                     # 项目的主要读我文件
|-- devcontainer                  # Docker容器配置，便于开发者环境一致性
|-- Cargo.toml                   # CADmium Rust库的配置文件
|-- pnpm-workspace.yaml           # Pnpm工作区配置，管理多包项目
|-- package.json                  # Node.js项目的配置
|-- pnpm-lock.yaml                # Pnpm的锁文件，记录确切版本依赖
|-- turbopack.json               # 用于Turbopack的配置（如果有）

2. 项目启动文件介绍

CADmium项目依赖于Pnpm作为包管理和工作区工具，以及SvelteKit和Tauri来分别处理前端界面和潜在的原生应用打包。

前端启动：

前端应用的启动主要通过SvelteKit，命令位于根目录下执行：

pnpm dev

这将启动本地开发服务器，允许你实时预览和调试Web应用。

Rust服务端或库编译测试：

对于Rust部分，可以使用标准的Cargo命令进行编译和测试。例如，运行所有Rust测试：

cargo test

原生应用编译与启动（如果项目提供了该选项）：

使用Tauri框架编译和部署原生应用，命令如下：

pnpm tauri dev

或生成发布版本：

pnpm tauri build

3. 项目配置文件介绍

Cargo.toml: Rust项目的核心配置文件，定义了依赖、目标、版本等信息。对于CADmium，它不仅配置了Rust库的构建细节，还包括对truck-parking（底层B-Rep引擎）等外部库的依赖。
pnpm-workspace.yaml: 管理整个项目中多个Node.js包的配置，确保它们能够被正确地共享和版本控制。
package.json: 定义了Node.js应用程序的脚本命令、依赖项和元数据。关键脚本如dev用于启动开发环境，test用于执行测试等。
Cargo.lock: 锁定了Rust依赖的具体版本，确保每次构建都能复现相同的依赖环境。
LICENSE.md: 描述项目的许可协议，CADmium使用的是Elastic License 2.0，限制提供给第三方作为服务的使用方式。