docs: :memo: 更新项目文档

README.md

@@ -1,6 +1,45 @@
-# shuimu-dashboard-h5
+# 水母星球-数据看板系统-H5
 
-数据看板H5页面----水母星球客户数据管理系统
+## 数据看板H5页面----水母星球客户数据管理系统
+仓库地址：http://192.168.2.106/app/shuimu-dashboard-h5.git
 
-代码仓库分支约定：master分支代码始终用于正式环境（方便bug修复而不影响新开发的后续内容），developer分支用于开发和测试环境，上线时在developer分支测试通过后合并到master分支上线正式环境。
-多人协作同时开发时（同项目不同模块），每个开发者在developer分支基础上新建一个自己的分支（比如：developerA），后续再合并到developer。
+## npm scripts：
+```json
+{
+    "scripts": {
+        "dev": "vite serve --mode development",
+        "build:prod": "vite build --mode production &&vue-tsc --noEmit",
+        "preview": "vite preview"
+    }
+}
+```
+
+## 本地启动
+```shell
+npm install
+npm run dev
+```
+
+## 构建应用
+```shell
+npm run build:prod
+```
+默认情况下，构建会输出到 dist 文件夹中。你可以部署这个 dist 文件夹到任何你喜欢的平台。
+
+## 本地测试应用
+当你构建完成应用后，你可以通过运行 `npm run preview` 命令，在本地测试该应用。
+```shell
+npm run build:prod
+npm run preview
+```
+`vite preview` 命令会在本地启动一个静态 Web 服务器，将 dist 文件夹运行在 http://localhost:4173。
+
+如遇到端口冲突，可以通过 --port 参数来配置服务的运行端口。
+``` json
+{
+    "scripts": {
+        "preview": "vite preview --port 8080"
+    }
+}
+```
+现在 preview 命令会将服务器运行在 http://localhost:8080。

package.json

@@ -7,6 +7,7 @@
     "preinstall": "npx only-allow pnpm",
     "dev": "vite serve --mode development",
     "build:prod": "vite build --mode production &&vue-tsc --noEmit",
+    "preview": "vite preview",
     "prepare": "husky install",
     "lint:eslint": "eslint  --fix --ext .ts,.js,.vue ./src ",
     "lint:prettier": "prettier --write \"**/*.{js,cjs,ts,json,tsx,css,less,scss,vue,html,md}\"",