OpenJSCAD.org 项目教程

OpenJSCAD.org 项目教程

OpenJSCAD.org项目地址:https://gitcode.com/gh_mirrors/ope/OpenJSCAD.org

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

OpenJSCAD.org 是一个用于创建参数化 2D 和 3D 设计的开源项目，使用 JavaScript 编写。项目的目录结构如下：

OpenJSCAD.org/
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── coverage_reports/
├── jsdoc/
├── lerna.json
├── package.json
├── packages/
│   ├── @jscad/
│   │   ├── cli/
│   │   ├── core/
│   │   ├── io/
│   │   ├── modeling/
│   │   ├── regl-renderer/
│   │   ├── utils/
│   │   ├── web/
│   │   ├── web-editor/
│   │   ├── web-ui/
│   │   ├── x3d-serializer/
│   │   └── ...
│   └── ...
└── ...

主要目录介绍

• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• coverage_reports/: 代码覆盖率报告。
• jsdoc/: 生成的 JSDoc 文档。
• lerna.json: Lerna 配置文件，用于管理多包仓库。
• package.json: 项目的主配置文件。
• packages/: 包含项目的各个模块和工具。

2. 项目的启动文件介绍

OpenJSCAD.org 项目的启动文件主要位于 packages/ 目录下。以下是一些关键的启动文件：

• packages/@jscad/cli/bin/jscad: 命令行接口的启动脚本。
• packages/@jscad/web/index.html: 网页版本的入口文件。
• packages/@jscad/web-editor/index.html: 网页编辑器的入口文件。

命令行接口启动

要启动命令行接口，可以使用以下命令：

node packages/@jscad/cli/bin/jscad

网页版本启动

要启动网页版本，可以在浏览器中打开 packages/@jscad/web/index.html 文件。

网页编辑器启动

要启动网页编辑器，可以在浏览器中打开 packages/@jscad/web-editor/index.html 文件。

3. 项目的配置文件介绍

OpenJSCAD.org 项目的主要配置文件包括 package.json 和 lerna.json。

package.json

package.json 文件包含了项目的基本信息、依赖项、脚本命令等。以下是一些关键配置项：

{
  "name": "openjscad",
  "version": "1.0.0",
  "description": "OpenJSCAD - JavaScript CAD",
  "main": "index.js",
  "scripts": {
    "start": "node packages/@jscad/cli/bin/jscad",
    "build": "lerna run build"
  },
  "dependencies": {
    "@jscad/cli": "^2.0.0",
    "@jscad/core": "^2.0.0",
    "@jscad/io": "^2.0.0",
    "@jscad/modeling": "^2.0.0",
    "@jscad/regl-renderer": "^2.0.0",
    "@jscad/utils": "^2.0.0",
    "@jscad/web": "^2.0.0",
    "@jscad/web-editor": "^2.0.0",
    "@jscad/web-ui": "^2.0.0",
    "@jscad/x3d-serializer": "^2.0.0"
  }
}

lerna.json

lerna.json 文件用于配置 Lerna 工具，管理多包仓库。以下是一些关键配置项：

{
  "packages": [
    "packages/*"
  ],
  "version": "independent"
}

通过这些配置文件，可以管理和构建 OpenJSCAD.org 项目的各个模块和工具

OpenJSCAD.org项目地址:https://gitcode.com/gh_mirrors/ope/OpenJSCAD.org