@glodon-aiot/libs 0.0.0-20251107034219

package/README.git.md

@@ -0,0 +1,73 @@
+git 使用文档 | [组件库使用文档](./README.lib.md)
+
+## 模板工程使用：
+
+### 模板代码拉取与安装
+
+`git clone https://geek.glodon.com/scm/gos/aiot-standard-frontend.git`，克隆代码。
+
+`yarn install`,安装项目所有依赖。
+
+yarn 安装可参考：https://blog.csdn.net/qq_45112637/article/details/125543953
+
+`yarn start`，运行模板项目。
+
+### 贡献代码
+
+`git switch master`，切换分支 master。
+
+`git pull`，获取 master 最新代码。
+
+`git switch –c feature/xxx`，在 master 分支下创建并切换到新分支 feature/xxx。
+
+在新分支编写代码。
+
+`git add .`，把所有文件修改添加到暂存区。
+
+`git commit -m "备注信息"`，将暂存区内容添加到本地仓库。
+
+`git push`，把本地仓库的更新推到远程仓库。
+
+分支代码完成后提 PR，将分支`feature/xxx`merge 到 develop 分支。
+
+- 若有冲突，`git switch feature/xxx`切换到该分支，然后`git pull origin develop`，手动解决冲突之后再次提交代码。
+- 没有冲突且测试没有问题，再提 PR，将 develop 分支 merge 到 master 分支。
+
+### 更换远程仓库
+
+**可向自己的代码仓库提交代码，不要在模板项目上提交代码哦~**
+
+关联远程库例子：`git remote add origin git@server-name:path/repo-name.git`，可参考https://www.liaoxuefeng.com/wiki/896043488029600/898732864121440。
+
+`git add .`，把所有文件修改添加到暂存区。
+
+`git commit -m "备注信息"`，将暂存区内容添加到本地仓库。
+
+`git push`，把本地仓库的更新推到远程仓库。
+
+## 代码提交规范:
+
+[@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional)
+
+```
+{
+  'build': 打包
+  'chore': 性能,
+  'ci': 脚手架/工程化,
+  'docs': 文档,
+  'feat' : 新功能,
+  'fix': 修改bug,
+  'perf': 性能优化,
+  'refactor': 重构,
+  'revert'： 回退,
+  'style': 样式,
+  'test': 单元测试
+}
+```
+
+举个例子
+```
+git commit -m "fix: some bug"
+
+git commit -m "feat: some feautre"
+```

package/README.lib.md

@@ -0,0 +1,135 @@
+[git 使用文档](./README.git.md) | 组件库使用文档
+
+## 组件库使用文档
+
+### 项目结构
+
+```
+sdk/
+ |-.husky
+ |-.storybook
+ |-dist/
+ |-example/
+   |-App.tsx
+   |-main.tsx
+ |-node_modules/
+ |-packages/
+   |-api/
+     |-common
+       |-base.api.ts
+       |-base.model.ts
+     |-panorama
+       |-index.ts
+       |-model.ts
+     |-index.ts
+   |-react-biz-components/
+     |-PanoramaMap
+       |-index.ts
+       |-style.less
+   |-react-components/
+     |-Button
+       |-index.ts
+       |-style.less
+   |-index.tsx
+ |-public/
+ |-stories/
+   |-Button/
+     |-Button.stories.tsx
+ |-package.json
+ |-index.html
+ |-vite.config
+```
+
+| 目录/文件  | 作用介绍                    |
+| ---------- | --------------------------- |
+| .storybook | 文档预览服务的配置文件      |
+| dist       | 打包文件，上传到 npm 上的包 |
+| example    | 开发组件挂在在 root         |
+| packages   | 需要开发的组件              |
+| stories    | 需要生成预览文档的组件      |
+
+#### 组件开发
+
+1、项目启动： `npm run dev`
+
+2、预览：`http://localhost:3000`
+
+3、App.tsx 中引入 packages 中开发的组件，example 中示例如下：
+
+```
+import React from 'react';
+import { Button } from '../packages/index';
+const Test = () => {
+  return (
+    <div>
+      <Button label="按钮" primary></Button>
+    </div>
+  );
+};
+
+export default Test;
+```
+
+### 组件发布
+
+1、执行`npm run build`打包文件
+
+2、命令行使用`npm login`登录 npm
+
+3、使用`npm publish`发布
+
+package.json 上定义的基础入口信息和类型声明
+
+```
+  {
+	  "name": "aiot-panorama-jssdk",
+	  "private": false,
+	  "version": "0.0.2",
+	  "description": "React components",
+	  "type": "module",
+	  "keywords": [
+		"react",
+		"react-component"
+	  ],
+	  "files": [
+		"dist"
+	  ],
+	  "main": "./dist/aiot-panorama-jssdk.umd.cjs",
+	  "module": "./dist/aiot-panorama-jssdk.js",
+	  "typings": "./dist/index.d.ts",
+	  "exports": {
+		".": {
+		  "import": "./dist/aiot-panorama-jssdk.js",
+		  "require": "./dist/aiot-panorama-jssdk.umd.cjs"
+		},
+		"./style.css": "./dist/style.css"
+	  },
+	  "repository": "",
+	  "author": "gspace",
+	  "license": "MIT"
+  }
+```
+
+### 组件使用
+
+#### 安装
+
+```bash
+yarn add aiot-panorama-jssdk
+```
+
+#### 使用
+
+```
+import { Button } from 'aiot-panorama-jssdk';
+import "aiot-panorama-jssdk/style.css"
+
+<Button label="按钮" primary></Button>
+
+```
+
+附：
+
+[storybook 中文使用文档](https://storybook.js.org/tutorials/design-systems-for-developers/react/zh-CN/document/)
+
+[storybook 英文使用文档](https://storybook.js.org/docs/react/get-started/introduction)