From 378d781e6f35f89652aa36e079a8b7fc44cea77e Mon Sep 17 00:00:00 2001
From: zhitong.yu <xynz17@163.com>
Date: 星期五, 14 十一月 2025 15:37:32 +0800
Subject: [PATCH] BS通用版本1.1.9
---
README.md | 211 ++++++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 209 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index e78a1c8..6b25bca 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,211 @@
-## BSF
+# BSF 椤圭洰
-瀹氫綅骞冲彴鍓嶇
+## 椤圭洰鏋舵瀯 馃摉
+### 鎶�鏈爤
+
+- **鍓嶇妗嗘灦**锛歏ue3.4 + TypeScript
+- **鏋勫缓宸ュ叿**锛歏ite5
+- **鐘舵�佺鐞�**锛歅inia
+- **UI妗嗘灦**锛欵lement-Plus
+- **璺敱**锛歏ue Router
+- **HTTP璇锋眰**锛欰xios锛堜簩娆″皝瑁咃級
+- **浠ｇ爜瑙勮寖**锛欵SLint + Prettier + Stylelint
+- **Git鎻愪氦瑙勮寖**锛歨usky + lint-staged + commitlint
+
+### 椤圭洰缁撴瀯
+
+```
+BSF
+鈹溾攢 .husky # husky 閰嶇疆鏂囦欢
+鈹溾攢 .vscode # VSCode 鎺ㄨ崘閰嶇疆
+鈹溾攢 build # Vite 閰嶇疆椤�
+鈹溾攢 public # 闈欐�佽祫婧愭枃浠讹紙璇ユ枃浠跺す涓嶄細琚墦鍖咃級
+鈹溾攢 src
+鈹� 鈹溾攢 api # API 鎺ュ彛绠＄悊
+鈹� 鈹溾攢 assets # 闈欐�佽祫婧愭枃浠�
+鈹� 鈹溾攢 components # 鍏ㄥ眬缁勪欢
+鈹� 鈹溾攢 config # 鍏ㄥ眬閰嶇疆椤�
+鈹� 鈹溾攢 directives # 鍏ㄥ眬鎸囦护鏂囦欢
+鈹� 鈹溾攢 enums # 椤圭洰甯哥敤鏋氫妇
+鈹� 鈹溾攢 hooks # 甯哥敤 Hooks 灏佽
+鈹� 鈹溾攢 languages # 璇█鍥介檯鍖� i18n
+鈹� 鈹溾攢 layouts # 妗嗘灦甯冨眬妯″潡
+鈹� 鈹溾攢 routers # 璺敱绠＄悊
+鈹� 鈹溾攢 stores # pinia store
+鈹� 鈹溾攢 styles # 鍏ㄥ眬鏍峰紡鏂囦欢
+鈹� 鈹溾攢 typings # 鍏ㄥ眬 ts 澹版槑
+鈹� 鈹溾攢 utils # 甯哥敤宸ュ叿搴�
+鈹� 鈹溾攢 views # 椤圭洰鎵�鏈夐〉闈�
+鈹� 鈹溾攢 App.vue # 椤圭洰涓荤粍浠�
+鈹� 鈹溾攢 main.ts # 椤圭洰鍏ュ彛鏂囦欢
+鈹� 鈹斺攢 vite-env.d.ts # 鎸囧畾 ts 璇嗗埆 vue
+鈹溾攢 .editorconfig # 缁熶竴涓嶅悓缂栬緫鍣ㄧ殑缂栫爜椋庢牸
+鈹溾攢 .env # vite 甯哥敤閰嶇疆
+鈹溾攢 .env.development # 寮�鍙戠幆澧冮厤缃�
+鈹溾攢 .env.production # 鐢熶骇鐜閰嶇疆
+鈹溾攢 .env.test # 娴嬭瘯鐜閰嶇疆
+鈹溾攢 .eslintignore # 蹇界暐 Eslint 鏍￠獙
+鈹溾攢 .eslintrc.cjs # Eslint 鏍￠獙閰嶇疆鏂囦欢
+鈹溾攢 .gitignore # 蹇界暐 git 鎻愪氦
+鈹溾攢 .prettierignore # 蹇界暐 Prettier 鏍煎紡鍖�
+鈹溾攢 .prettierrc.cjs # Prettier 鏍煎紡鍖栭厤缃�
+鈹溾攢 .stylelintignore # 蹇界暐 stylelint 鏍煎紡鍖�
+鈹溾攢 .stylelintrc.cjs # stylelint 鏍峰紡鏍煎紡鍖栭厤缃�
+鈹溾攢 CHANGELOG.md # 椤圭洰鏇存柊鏃ュ織
+鈹溾攢 commitlint.config.cjs # git 鎻愪氦瑙勮寖閰嶇疆
+鈹溾攢 index.html # 鍏ュ彛 html
+鈹溾攢 LICENSE # 寮�婧愬崗璁枃浠�
+鈹溾攢 lint-staged.config.cjs # lint-staged 閰嶇疆鏂囦欢
+鈹溾攢 package-lock.json # 渚濊禆鍖呭寘鐗堟湰閿�
+鈹溾攢 package.json # 渚濊禆鍖呯鐞�
+鈹溾攢 postcss.config.cjs # postcss 閰嶇疆
+鈹溾攢 README.md # README 浠嬬粛
+鈹溾攢 tsconfig.json # typescript 鍏ㄥ眬閰嶇疆
+鈹斺攢 vite.config.ts # vite 鍏ㄥ眬閰嶇疆鏂囦欢
+```
+
+### 鏍稿績鍔熻兘
+
+- 浣跨敤 Vue3.4 + TypeScript 寮�鍙戯紝鍗曟枃浠剁粍浠�**锛渟cript setup锛�**
+- 閲囩敤 Vite5 浣滀负椤圭洰寮�鍙戙�佹墦鍖呭伐鍏凤紙閰嶇疆 gzip/brotli 鎵撳寘銆乼sx 璇硶銆佽法鍩熶唬鐞嗏�︼級
+- 浣跨敤 Pinia 鏇夸唬 Vuex锛岃交閲忋�佺畝鍗曘�佹槗鐢紝闆嗘垚 Pinia 鎸佷箙鍖栨彃浠�
+- 浣跨敤 TypeScript 瀵� Axios 鏁翠釜浜屾灏佽锛堣姹傛嫤鎴�佸彇娑堛�佸父鐢ㄨ姹傚皝瑁呪�︼級
+- 鍩轰簬 Element 浜屾灏佽 ProTable 缁勪欢锛岃〃鏍奸〉闈㈠叏閮ㄤ负閰嶇疆椤� Columns
+- 鏀寔 Element 缁勪欢澶у皬鍒囨崲銆佸涓婚甯冨眬銆佹殫榛戞ā寮忋�乮18n 鍥介檯鍖�
+- 浣跨敤 VueRouter 閰嶇疆鍔ㄦ�佽矾鐢辨潈闄愭嫤鎴�佽矾鐢辨噿鍔犺浇锛屾敮鎸侀〉闈㈡寜閽潈闄愭帶鍒�
+- 浣跨敤 KeepAlive 瀵归〉闈㈣繘琛岀紦瀛橈紝鏀寔澶氱骇宓屽璺敱缂撳瓨
+- 甯哥敤鑷畾涔夋寚浠ゅ紑鍙戯紙鏉冮檺銆佸鍒躲�佹按鍗般�佹嫋鎷姐�佽妭娴併�侀槻鎶栥�侀暱鎸夆�︼級
+- 浣跨敤 Prettier 缁熶竴鏍煎紡鍖栦唬鐮侊紝闆嗘垚 ESLint銆丼tylelint 浠ｇ爜鏍￠獙瑙勮寖
+- 浣跨敤 husky銆乴int-staged銆乧ommitlint銆乧zg銆乧z-git 瑙勮寖鎻愪氦淇℃伅
+
+## 閮ㄧ讲鎸囧崡 馃殌
+
+### 鐜瑕佹眰
+
+- Node.js >= 16
+- pnpm >= 8
+
+### 瀹夎姝ラ
+
+1. **鍏嬮殕椤圭洰**
+
+```bash
+# 鍏嬮殕椤圭洰
+git clone [椤圭洰鍦板潃]
+
+# 杩涘叆椤圭洰鐩綍
+cd BSF
+```
+
+2. **瀹夎渚濊禆**
+
+```bash
+# 瀹夎渚濊禆
+pnpm install
+```
+
+### 寮�鍙戠幆澧�
+
+```bash
+# 鍚姩寮�鍙戞湇鍔″櫒
+pnpm dev
+```
+
+### 鏋勫缓閮ㄧ讲
+
+```bash
+# 寮�鍙戠幆澧冩瀯寤�
+pnpm build:dev
+
+# 娴嬭瘯鐜鏋勫缓
+pnpm build:test
+
+# 鐢熶骇鐜鏋勫缓
+pnpm build:pro
+```
+
+鏋勫缓鍚庣殑鏂囦欢浣嶄簬 `dist` 鐩綍锛屽彲浠ュ皢璇ョ洰褰曚笅鐨勬枃浠堕儴缃插埌鏈嶅姟鍣ㄤ笂銆�
+
+### 浠ｇ爜妫�鏌�
+
+```bash
+# eslint 妫�娴嬩唬鐮�
+pnpm lint:eslint
+
+# prettier 鏍煎紡鍖栦唬鐮�
+pnpm lint:prettier
+
+# stylelint 鏍煎紡鍖栨牱寮�
+pnpm lint:stylelint
+```
+
+### 鎻愪氦浠ｇ爜
+
+```bash
+# 鎻愪氦浠ｇ爜锛堟彁浜ゅ墠浼氳嚜鍔ㄦ墽琛� lint:lint-staged 鍛戒护锛�
+pnpm commit
+```
+
+### 鏈嶅姟鍣ㄩ儴缃�
+
+1. **Nginx 閰嶇疆绀轰緥**
+
+```nginx
+server {
+ listen 80;
+ server_name your-domain.com;
+ root /path/to/dist;
+ index index.html;
+
+ # 澶勭悊 Vue Router 鐨� history 妯″紡
+ location / {
+ try_files $uri $uri/ /index.html;
+ }
+
+ # 闈欐�佽祫婧愮紦瀛�
+ location ~* \.(js|css|png|jpg|jpeg|gif|ico|svg)$ {
+ expires 1y;
+ add_header Cache-Control "public, immutable";
+ }
+}
+```
+
+2. **Docker 閮ㄧ讲**
+
+```dockerfile
+# 鏋勫缓闃舵
+FROM node:16-alpine AS builder
+
+WORKDIR /app
+COPY package*.json ./
+RUN npm install -g pnpm
+RUN pnpm install
+COPY . .
+RUN pnpm build:pro
+
+# 鐢熶骇闃舵
+FROM nginx:alpine
+COPY --from=builder /app/dist /usr/share/nginx/html
+COPY nginx.conf /etc/nginx/conf.d/default.conf
+EXPOSE 80
+CMD ["nginx", "-g", "daemon off;"]
+```
+
+### 鐜鍙橀噺閰嶇疆
+
+椤圭洰鏀寔澶氱幆澧冮厤缃紝閫氳繃涓嶅悓鐨勭幆澧冩枃浠舵潵鍖哄垎锛�
+
+- `.env` - 閫氱敤閰嶇疆
+- `.env.development` - 寮�鍙戠幆澧冮厤缃�
+- `.env.test` - 娴嬭瘯鐜閰嶇疆
+- `.env.production` - 鐢熶骇鐜閰嶇疆
+
+### 娴忚鍣ㄦ敮鎸�
+
+- 鏈湴寮�鍙戞帹鑽愪娇鐢� Chrome 鏈�鏂扮増娴忚鍣�
+- 鐢熶骇鐜鏀寔鐜颁唬娴忚鍣紝涓嶅啀鏀寔 IE 娴忚鍣�
+
+| Edge | Firefox | Chrome | Safari |
+| :--: | :-----: | :----: | :----: |
+| last 2 versions | last 2 versions | last 2 versions | last 2 versions |
--
Gitblit v1.9.3