Webwidget V1.0 ——开发者文档

公告 更新日志
1

1. 应用脚手架

1.1 项目描述

本仓库包含一个脚手架，帮助开发者构建新核云应用

1.2 快速开始

1.2.1 环境依赖

  • Node.js ≥ 18.12.1

1.2.2 安装配置

  1. 克隆本仓库
  2. 运行pnpm install
1.2.2.1 开发环境

打开新终端运行 pnpm run dev

注意 ： pnpm run dev命令启用了热模块替换(HMR)，您对代码的修改将立即生效而无需手动刷新页面，极大提升开发体验。

1.2.2.2 生产环境
  1. 打开新终端运行 pnpm run build
  2. 上传至新核云插件平台
  3. 开启应用状态（如已开启请忽略）
    注意：不建议修改打包产物的配置文件！

1.3 为什么选择此脚手架？

本脚手架提供多种功能帮助您维护和扩展应用，以下为部分特性（无需预先掌握这些技术）：

  • ECMAScript(ES2022) - 支持最新JavaScript标准
  • Vite构建工具 - 基于Rollup的高效模块打包
  • PostCSS样式处理 - 支持CSS变量、混入等高级特性
  • 优化构建 - 自动代码分割和tree shaking
  • Vitest测试框架 - 与Vite生态无缝集成的测试方案

1.4 目录结构

1.4.1 目录/文件

.github/： PR模板、ISSUE模板等存放位置

dist/： 构建产物目录

src/： 源代码目录(JS/CSS/模板/翻译文件)

rollup/：支持i18n的静态复制和翻译加载插件

vite.config.js：Vite配置文件

package.json：项目元数据和依赖配置

1.4.2 核心目录说明

  • dist：构建生成的目录，包含manifest.json和编译后的静态资源
  • src：源代码主目录，包含国际化文件zh-CN.json/en-US.json
  • vite.config.ts：配置Vite构建参数，集成@newcore/client SDK

1.5 国际化(I18n)

/src/lib/i18n.ts模块提供t方法进行翻译键值查找。语言文件应命名为：

  • 中文：zh-CN.json
  • 英文：en-US.json

1.6 SDK文档

参考新核云SDK技术文档。

1.7 问题反馈

通过联系管理员进行反馈。

1.8 版权声明

版权所有：新核云