/vis-three

more convenient development for three.js

Primary LanguageHTMLGNU Affero General Public License v3.0AGPL-3.0

vis-three

three.js 库二次功能封装 + 配置化的 three.js 开发。

由于目前需要解决生存问题,后面的版本展示不开源,详细情况可查看:https://www.bilibili.com/video/BV1Tg411i7Xu

NPM npm npm coverage

主页、demo、文档在线地址

gitee 视频资源会失效

安装

npm i vis-three

导入

// 整体导入
import * as Vis from "vis-three";

// 按需导入
import {
  ModelingEngineSupport,
  SupportDataGenerator,
  generateConfig,
} from "vis-three";

备注

项目结构说明

  • srcvis-three 库源码
  • website主页源码
  • docs文档源码
  • examples例子库源码
  • arts美术资源
  • cypresse2e 测试用例源码
  • distvis-three 库 build
  • dist-website主页 build
  • js-source tsc 编译 js 版本
  • typesvis-three 的声明文件
  • uitls项目级别工具库

开发说明

  • 例子或者网页需要添加额外依赖的,请添加到devDependencies中:npm i xxxx -D
  • 提交更新之后请到/docs/version下简写更新功能
  • 开发期请使用jsdoc进行注释辅助

项目命令

website 的最终展现是使用的其他模块的 build 版本,如需要更新请先执行相应的:bulid构建。

  • 开发:npm run dev
  • 构建: npm run build
  • 代码格式化: npm run lint

列子

  • 例子开发: npm run examples:dev
  • 例子构建: npm run examples:build

文档

  • 文档开发: npm run docs:dev
  • 文档构建: npm run docs:build
  • 文档服务: npm run docs:serve

主页

  • 主页开发: npm run website:dev
  • 主页构建: npm run website:build
  • 主页代码格式化: npm run website:lint

测试

  • 单元测试: npm run test:unit
  • e2e 测试: npm run test:e2e
  • 自定义测试: npm run test:open
  • 查看测试报告: npm run test:report

贡献者