CADmium 项目使用教程

CADmium 项目使用教程

CADmium A CAD program that runs in the browser 项目地址: https://gitcode.com/gh_mirrors/cad/CADmium

1. 项目的目录结构及介绍

CADmium 项目的目录结构如下：

CADmium/
├── applications/
│   └── web/
├── packages/
│   └── cadmium/
├── devcontainer/
├── github/
├── vscode/
├── .gitignore
├── .npmrc
├── .prettierignore
├── Cargo.lock
├── Cargo.toml
├── LICENSE.md
├── Notes.md
├── README.md
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── turbo.json
└── ...

目录结构介绍

• applications/: 包含项目的应用代码，主要用于 Web 应用。
  • web/: Web 应用的主要代码目录。
• packages/: 包含项目的 Rust 库代码。
  • cadmium/: 提供 CAD 功能的 Rust 库。
• devcontainer/: 开发容器配置文件。
• github/: GitHub 相关配置文件。
• vscode/: Visual Studio Code 相关配置文件。
• .gitignore: Git 忽略文件配置。
• .npmrc: npm 配置文件。
• .prettierignore: Prettier 忽略文件配置。
• Cargo.lock: Rust 项目的锁定文件。
• Cargo.toml: Rust 项目的配置文件。
• LICENSE.md: 项目许可证文件。
• Notes.md: 项目笔记文件。
• README.md: 项目说明文件。
• package.json: Node.js 项目的配置文件。
• pnpm-lock.yaml: pnpm 锁定文件。
• pnpm-workspace.yaml: pnpm 工作区配置文件。
• turbo.json: Turbo 配置文件。

2. 项目的启动文件介绍

Web 应用启动文件

在 applications/web/ 目录下，主要的启动文件是 package.json 和 pnpm-workspace.yaml。

• package.json: 定义了项目的依赖和脚本命令。
• pnpm-workspace.yaml: 定义了 pnpm 工作区的配置。

Rust 库启动文件

在 packages/cadmium/ 目录下，主要的启动文件是 Cargo.toml。

• Cargo.toml: 定义了 Rust 库的依赖和配置。

3. 项目的配置文件介绍

主要配置文件

• .gitignore: 定义了 Git 忽略的文件和目录。
• .npmrc: 定义了 npm 的配置。
• .prettierignore: 定义了 Prettier 忽略的文件和目录。
• Cargo.toml: 定义了 Rust 项目的依赖和配置。
• package.json: 定义了 Node.js 项目的依赖和脚本命令。
• pnpm-lock.yaml: 定义了 pnpm 的锁定文件。
• pnpm-workspace.yaml: 定义了 pnpm 工作区的配置。
• turbo.json: 定义了 Turbo 的配置。

其他配置文件

• devcontainer/: 开发容器配置文件。
• github/: GitHub 相关配置文件。
• vscode/: Visual Studio Code 相关配置文件。

通过以上配置文件，可以对项目进行详细的配置和管理。

CADmium A CAD program that runs in the browser 项目地址: https://gitcode.com/gh_mirrors/cad/CADmium