ThreeGN 项目教程

1. 项目目录结构及介绍

ThreeGN 是一个基于 Web 的程序化 3D 图形编辑器，使用了 Three.js 和 React Flow。以下是项目的目录结构及其介绍：

threegn/
├── public/
│   ├── index.html
│   └── ...
├── src/
│   ├── components/
│   │   ├── NodeEditor.js
│   │   └── ...
│   ├── nodes/
│   │   ├── BaseNode.js
│   │   └── ...
│   ├── styles/
│   │   ├── main.css
│   │   └── ...
│   ├── App.js
│   ├── index.js
│   └── ...
├── .gitignore
├── package.json
├── README.md
└── ...

目录结构介绍

• public/: 存放静态文件，如 index.html 等。
• src/: 项目的源代码目录。
  • components/: 存放 React 组件，如 NodeEditor.js 等。
  • nodes/: 存放节点相关的代码，如 BaseNode.js 等。
  • styles/: 存放样式文件，如 main.css 等。
  • App.js: 项目的根组件。
  • index.js: 项目的入口文件。
• .gitignore: Git 忽略文件配置。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目的说明文档。

2. 项目启动文件介绍

项目的启动文件是 src/index.js，它是整个应用的入口点。以下是 index.js 的简要介绍：

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App />, document.getElementById('root'));

启动文件介绍

• ReactDOM.render(): 将 App 组件渲染到 index.html 中的 root 元素中。
• App.js: 项目的根组件，包含了整个应用的逻辑和结构。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的依赖、脚本和其他配置信息。以下是 package.json 的简要介绍：

{
  "name": "threegn",
  "version": "1.0.0",
  "description": "Procedural 3D graphics editor for the web",
  "main": "src/index.js",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "three": "^0.130.1",
    "react-flow": "^9.1.0"
  },
  "devDependencies": {
    "eslint": "^7.25.0",
    "prettier": "^2.2.1"
  },
  "license": "EPL-2.0"
}

配置文件介绍

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目的入口文件。
• scripts: 项目的脚本配置，如 start、build、test 等。
• dependencies: 项目的生产环境依赖。
• devDependencies: 项目的开发环境依赖。
• license: 项目的开源许可证。

通过以上介绍，您可以更好地理解 ThreeGN 项目的结构和配置，从而更高效地进行开发和维护。