From 7db777a85e53e04b701c6a31f0aec0a197dc0150 Mon Sep 17 00:00:00 2001
From: tjx <t2856754968@163.com>
Date: 星期日, 12 十月 2025 15:48:40 +0800
Subject: [PATCH] 补充项目的说明文档

---
 README.md |   46 ++++++++++++++++++++++++++++++++++++++++++++--
 1 files changed, 44 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d722277..c2ce195 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,46 @@
-## LB_MesService
+# GS MES 鏈嶅姟
 
-钃濆疂PC鍚庣
+## 椤圭洰姒傝
+GS MES Service 鍩轰簬 ASP.NET Core 8.0 鏋勫缓锛宍Gs.HostIIS` 璐熻矗鎵樼 Web API銆佸姞杞介厤缃苟鏆撮湶鍒嗙粍鍖� Swagger 鏂囨。銆傚悇涓氬姟妯″潡锛圔aseInfo銆丼ales銆乄arehouse 绛夛級浠� `Gs.<Module>` 椤圭洰瀛樺湪锛屾帶鍒跺櫒鏀惧湪 `Services/`锛屾暟鎹ā鍨嬩綅浜� `Models/`锛屽叡浜疄浣撳拰 DTO 闆嗕腑鍦� `Gs.Entity`銆傞�氱敤缁勪欢锛堟巿鏉冦�丒xcel銆丠TTP銆佷緷璧栨敞鍏ユ墿灞曠瓑锛夌粺涓�灏佽鍦� `Gs.Toolbox`銆�
 
+## 鐩綍缁撴瀯
+- `GsMesSolution.sln`锛氳В鍐虫柟妗堝叆鍙ｏ紝缁熶竴鎵ц鏋勫缓銆佹祴璇曘��
+- `Gs.HostIIS/`锛氬涓婚」鐩紝鍖呭惈 `Program.cs`銆乣appsettings*.json`銆丼wagger 閰嶇疆浠ュ強 `/down`銆乣/upload` 闈欐�佽祫婧愭槧灏勩��
+- `Gs.<Module>/`锛氫笟鍔℃ā鍧楋紙濡� `Gs.BaseInfo`銆乣Gs.Sales`銆乣Gs.Warehouse`锛夛紝閬靛惊 `Models/` + `Services/` 鏂囦欢澶瑰竷灞�銆�
+- `Gs.Entity/`锛歋qlSugar 瀹炰綋涓庤法妯″潡鍏变韩鐨� DTO銆�
+- `Gs.Toolbox/`锛氫緷璧栨敞鍏ユ墿灞曘�丄PI 绾﹀畾銆佹棩蹇椼�丒xcel 宸ュ叿绛夊熀纭�璁炬柦鑳藉姏銆�
+- `Gs.HostIIS/.config/`锛氶儴缃查樁娈典娇鐢ㄧ殑鐜閰嶇疆杞崲鏂囦欢銆�
+
+## 蹇�熷紑濮�
+1. 瀹夎 .NET SDK 8.0锛岀‘璁ゆ暟鎹簱杩炴帴淇℃伅涓� `appsettings.json` 瀵瑰簲銆�
+2. 鎭㈠渚濊禆锛�
+   ```bash
+   dotnet restore GsMesSolution.sln
+   ```
+3. 鏋勫缓椤圭洰锛�
+   ```bash
+   dotnet build GsMesSolution.sln -c Release
+   ```
+4. 鍚姩 API锛�
+   ```bash
+   dotnet run --project Gs.HostIIS/Gs.HostIIS.csproj
+   ```
+   鍚姩鍚庤闂� `http://localhost:<绔彛>/swagger` 鏌ョ湅鍒嗙粍 API 鏂囨。銆傞潤鎬佷笅杞界洰褰曟槧灏� `/down`锛屼笂浼犵洰褰曟槧灏� `/upload`锛岃矾寰勭敱閰嶇疆涓殑 `DownPath`銆乣UploadPath` 鎺у埗銆�
+
+## 娴嬭瘯璇存槑
+浠撳簱鏆傛湭寮曞叆鑷姩鍖栨祴璇曘�傛柊澧炲姛鑳芥椂璇峰湪鐩稿簲妯″潡鏃佸垱寤� xUnit 椤圭洰锛堢ず渚嬶細`Gs.Sales.Tests`锛夛紝娴嬭瘯鏂囦欢缁熶竴鍛藉悕涓� `*Tests.cs`銆侻ock SqlSugar 渚濊禆淇濇寔娴嬭瘯鍙噸澶嶏紝骞跺湪瑙ｅ喅鏂规鏍圭洰褰曟墽琛岋細
+```bash
+dotnet test
+```
+鎻愪氦鍙樻洿鍓嶈褰曟墜宸ュ啋鐑熺粨鏋滐紙Swagger 鍙敤鎬с�佹牳蹇冩帴鍙ｃ�佸叧閿瓨鍌ㄨ繃绋嬶級骞跺啓鍏� PR銆�
+
+## 閰嶇疆涓庡畨鍏�
+- 绂佹鎻愪氦浠讳綍纭紪鐮佺殑杩炴帴瀛楃涓叉垨瀵嗙爜锛屽紑鍙戦樁娈甸�氳繃 User Secrets 鎴栫幆澧冨彉閲忔敞鍏ャ��
+- 鐜宸紓閰嶇疆鏀惧叆 `.config` 鐩綍锛屽彂甯冩椂鎵ц杞崲锛屼笉鐩存帴淇敼鍩虹閰嶇疆銆�
+- 璋冩暣 SqlSugar 鏁版嵁缁撴瀯鍓嶅姟蹇呭湪棰勫彂甯冪幆澧冮獙璇侊紝骞跺湪鍏紑閮ㄧ讲鍓嶆鏌� Swagger 鏆撮湶鑼冨洿銆�
+
+## 璐＄尞鎸囧崡
+- 閬靛惊鍥涚┖鏍肩缉杩涖�佺被鍨� `PascalCase`銆佸眬閮ㄥ彉閲� `camelCase`銆佸父閲� `ALL_CAPS` 鐨勫懡鍚嶈鑼冿紝淇濇寔鍙┖寮曠敤鍚敤銆�
+- 鏂板鏈嶅姟閫氳繃 `Gs.Toolbox` 鐨勬墿灞曟柟娉曟敞鍐岋紝纭繚 `builder.AddCustomInject()` 娴佺▼瀹氫箟缁熶竴銆�
+- 鎻愪氦淇℃伅娌跨敤鍘嗗彶椋庢牸锛氱畝娲佺殑涓枃鍗曡璇存槑锛屼緥濡� `Baobiao: 淇瀵煎嚭寮傚父`銆�
+- PR 涓渶鍒楀嚭鍙楀奖鍝嶆ā鍧椼�侀厤缃垨鏁版嵁搴撳彉鏇淬�佽嚜鍔ㄥ寲娴嬭瘯涓庢墜宸ュ啋鐑熺粨鏋滐紝骞堕檮涓婄ず渚嬭姹傛垨鎴浘銆�

--
Gitblit v1.9.3