From f3a82fb0ed00d5562ebec272be3a675a06e24211 Mon Sep 17 00:00:00 2001 From: ck_yeun9 Date: Fri, 2 May 2025 17:04:48 +0800 Subject: [PATCH] update README.md. --- README.en.md | 93 +++++++++++++++++++++++++++++++++------------------- README.md | 66 ++++++++++++++++++++++++++----------- 2 files changed, 106 insertions(+), 53 deletions(-) diff --git a/README.en.md b/README.en.md index 13a047c..2324b43 100644 --- a/README.en.md +++ b/README.en.md @@ -18,12 +18,28 @@ 2. ##### SqlSugar——.Net aot ORM Fastest ORM Simple Easy Sqlite orm Oracle ORM Mysql Orm postgresql ORm SqlServer oRm 达梦 ORM 人大金仓 ORM 神通ORM C# ORM , C# ORM .NET ORM NET5 ORM .NET6 ORM ClickHouse orm QuestDb ,TDengine ORM,OceanBase orm,GaussDB orm ,Tidb orm Object/Relational Mapping. [SQLSugar, MIT License](https://github.com/DotNetNext/SqlSugar) +3. ##### Mailkit——A cross-platform .NET library for IMAP, POP3, and SMTP。[Mailkit,MIT License](https://github.com/jstedfast/MailKit) + +4. ##### Swashbuckle.AspNetCore——Swagger tools for documenting API's built on ASP.NET Core。[SwaggerUI,MIT License](https://github.com/domaindrivendev/Swashbuckle.AspNetCore) + +5. ##### Newtonsoft.Json——Json.NET is a popular high-performance JSON framework for .NET。[Newtonsoft.Json,MIT License](https://github.com/JamesNK/Newtonsoft.Json) + ### :exclamation: About this project: This project is a TS hotel management system backend API project built on .Net8, mainly for the 2.0 upgrade, welcome to Star & Fork. 1. All development should comply with the MIT open source license. 2. If you find bugs, feel free to raise an issue! +3. The project currently supports multiple databases and automated database/table creation. For implementation details, refer to the `InitializeDatabase` method in `Startup.cs`. +4. This project has implemented multi-database support (mainstream) based on the SQL Sugar framework. Below is the list of currently tested and verified database compatibility tables: + + | Database | Version | Support Create Table(Y/N) | Pass(Y/N) | + | ---------- | ---------------- | -------------------------- | ------------------------------------------------------------ | + | MariaDB | 10.11.10-MariaDB | Y | Y | + | PostgreSQL | 130020 | Y | Y | + | MySQL | 5.7+ | Y | Y | + | SQL Server | 2022 | Y | Y | + | Oracle | Unknown | N | Reference SQLSugar Document([SQLSugar](https://www.donet5.com)) | ### :thought_balloon: Development purpose: @@ -35,7 +51,7 @@ Operating System: Windows 11(x64) Development Tool: Microsoft Visual Studio 2022 (latest version of the system) -Database: PostgreSQL v16 +Database: MariaDB/PostgreSQL/MySQL/SQL Server Database Management Tool: DbGate @@ -50,52 +66,58 @@ Development Technology: .NET 8 WebAPI ### :open_file_folder: System structure: ``` -EOM.TSHotelManager.Web +EOM.TSHotelManagement.Web ├─ .git ├─ .gitignore -├─ EOM.TSHotelManager.Application +├─ EOM.TSHotelManagement.Application +│ ├─ EOM.TSHotelManagement.Application.csproj +│ ├─ BaseDto +│ ├─ Business +│ ├─ Employee +│ ├─ Sys +│ ├─ SystemManagement +│ ├─ Util +├─ EOM.TSHotelManagement.Common.Contract +│ ├─ EOM.TSHotelManagement.Common.Contract.csproj │ ├─ Business -│ ├─ EOM.TSHotelManager.Application.csproj +│ ├─ Employee │ ├─ Sys -│ ├─ Worker -│ ├─ Zero -├─ EOM.TSHotelManager.Common -│ ├─ EOM.TSHotelManager.Common.csproj -│ ├─ HttpHelper.cs -│ ├─ RecordHelper +│ ├─ SystemManagement │ ├─ Util -├─ EOM.TSHotelManager.Core +├─ EOM.TSHotelManagement.Common.Core +│ ├─ EOM.TSHotelManagement.Core.csproj +│ ├─ BaseEntity.cs │ ├─ Business -│ ├─ EOM.TSHotelManager.Core.csproj +│ ├─ Employee │ ├─ Sys -│ ├─ Worker -│ ├─ Zero -├─ EOM.TSHotelManager.EntityFramework -│ ├─ AppSettingsJson.cs -│ ├─ EOM.TSHotelManager.EntityFramework.csproj +│ ├─ SystemManagement +│ ├─ Util +├─ EOM.TSHotelManagement.EntityFramework +│ ├─ EOM.TSHotelManagement.EntityFramework.csproj │ ├─ Repository -│ │ └─ PgRepository.cs -│ ├─ dbsettings.json -├─ EOM.TSHotelManager.Web.sln -├─ EOM.TSHotelManager.WebApi +│ │ └─ GenericRepository.cs +├─ EOM.TSHotelManagement.Migration +│ ├─ EOM.TSHotelManagement.Migration.csproj +│ ├─ EntityBuilder.cs +├─ EOM.TSHotelManagement.Web.sln +├─ EOM.TSHotelManagement.Share +│ ├─ EOM.TSHotelManagement.Share.csproj +│ ├─ Interface +├─ EOM.TSHotelManagement.WebApi │ ├─ Controllers │ │ ├─ Business │ │ ├─ Sys -│ │ ├─ Worker -│ │ └─ Zero -│ ├─ EOM.TSHotelManager.WebApi.csproj -│ ├─ EOM.TSHotelManager.WebApi.csproj.user -│ ├─ EOM.TSHotelManager.WebApi.xml -│ ├─ MvcOptionsExtensions.cs +│ │ ├─ Employee +│ │ └─ SystemManagement +│ │ └─ Util +│ ├─ EOM.TSHotelManagement.WebApi.csproj +│ ├─ EOM.TSHotelManagement.WebApi.csproj.user +│ ├─ EOM.TSHotelManagement.WebApi.xml │ ├─ Program.cs -│ ├─ RouteConvention.cs -│ ├─ Router_Extension │ ├─ Startup.cs │ ├─ appsettings.Development.json │ ├─ appsettings.json ├─ LICENSE -├─ Library -│ ├─ CK.Common.dll ├─ README.en.md └─ README.md ``` @@ -122,6 +144,11 @@ EOM.TSHotelManager.Web **The author and development team strongly recommend using MariaDB database. Install the MariaDB database and start the service. Use a visualization management tool to create the database. You can quickly establish data tables and import data by opening the .sql suffix format files in the database script folder. Execution steps (taking MariaDB database as an example):** -**1. Use a visualization management tool to open the 数据库脚本/latest_MariaDB版本/tshotel-backstage-dbscript-table.sql file to create data tables.** +**1. Connect to the MariaDB database via a GUI management tool (e.g., HeidiSQL, DBeaver), then create a new database named `tshoteldb`.** + +**2. Execute the following SQL scripts using the GUI tool to create tables and import initial data:** + +- `数据库脚本/MariaDB/MDB_tshotel_script_table.sql` (Table schema) +- `数据库脚本/MariaDB/MDB_tshotel_script_data.sql` (Sample data) -**2. Then open the 数据库脚本/latest_MariaDB版本/tshotel-backstage-dbscript-data.sql file to import data.** + [![咖啡与网络/TopskyHotelManagementSystem-WebApi](https://gitee.com/java-and-net/topsky-hotel-management-system-web-api/widgets/widget_card.svg?colors=4183c4,ffffff,ffffff,e3e9ed,666666,9b9b9b)](https://gitee.com/java-and-net/topsky-hotel-manager-system-web-api) diff --git a/README.md b/README.md index 65e2c05..24c51dc 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,25 @@

star fork -

+ ### :pray: 感谢以下开源项目: 1. ##### Autofac——An addictive .NET IoC container。[Autofac, MIT开源协议](https://github.com/autofac/Autofac) 2. ##### SqlSugar——国内最受欢迎ORM框架。 [SQLSugar,Apache-2.0开源协议](https://gitee.com/dotnetchina/SqlSugar) +3. ##### Mailkit——A cross-platform .NET library for IMAP, POP3, and SMTP。[Mailkit,MIT开源协议](https://github.com/jstedfast/MailKit) + +4. ##### Swashbuckle.AspNetCore——Swagger tools for documenting API's built on ASP.NET Core。[SwaggerUI,MIT开源协议](https://github.com/domaindrivendev/Swashbuckle.AspNetCore) + +5. ##### Newtonsoft.Json——Json.NET is a popular high-performance JSON framework for .NET。[Newtonsoft.Json,MIT开源协议](https://github.com/JamesNK/Newtonsoft.Json) + ### :exclamation: 本项目介绍: @@ -25,6 +31,18 @@ 2、有bug欢迎提出issue! +3、本项目当前已支持多数据库以及一键建库建表,具体代码可以参考Startup.cs中的InitializeDatabase方法。 + +4、本项目已基于SQL Sugar框架支持多数据库(主流),以下是目前已通过测试的数据库表格: + +| 数据库 | 版本 | 支持建库建表(Y/N) | 通过(Y/N) | +| ---------- | ---------------- | ----------------- | ---------------------------------------------------- | +| MariaDB | 10.11.10-MariaDB | Y | Y | +| PostgreSQL | 130020 | Y | Y | +| MySQL | 5.7+ | Y | Y | +| SQL Server | 2022 | Y | Y | +| Oracle | Unknown | N | 请参照SQLSugar文档([果糖网](https://www.donet5.com)) | + ### :thought_balloon: 开发目的: 主要用于现有的C/S项目酒店管理系统升级2.0后实现前后端分离的WebAPI接口,本项目不包含任何UI界面。 @@ -35,7 +53,7 @@ 开发工具:Microsoft Visual Studio 2022(系统最新版本) -数据库:PostgreSQL v16 +数据库:MariaDB/PostgreSQL/MySQL/SQL Server 数据库管理工具:DbGate @@ -54,42 +72,50 @@ EOM.TSHotelManagement.Web ├─ .git ├─ .gitignore ├─ EOM.TSHotelManagement.Application -│ ├─ Business │ ├─ EOM.TSHotelManagement.Application.csproj +│ ├─ BaseDto +│ ├─ Business +│ ├─ Employee │ ├─ Sys -│ ├─ Worker -│ ├─ Zero -├─ EOM.TSHotelManagement.Common -│ ├─ EOM.TSHotelManagement.Common.csproj -│ ├─ HttpHelper.cs -│ ├─ RecordHelper +│ ├─ SystemManagement │ ├─ Util -├─ EOM.TSHotelManagement.Core +├─ EOM.TSHotelManagement.Common.Contract +│ ├─ EOM.TSHotelManagement.Common.Contract.csproj │ ├─ Business +│ ├─ Employee +│ ├─ Sys +│ ├─ SystemManagement +│ ├─ Util +├─ EOM.TSHotelManagement.Common.Core │ ├─ EOM.TSHotelManagement.Core.csproj +│ ├─ BaseEntity.cs +│ ├─ Business +│ ├─ Employee │ ├─ Sys -│ ├─ Worker -│ ├─ Zero +│ ├─ SystemManagement +│ ├─ Util ├─ EOM.TSHotelManagement.EntityFramework -│ ├─ AppSettingsJson.cs │ ├─ EOM.TSHotelManagement.EntityFramework.csproj │ ├─ Repository -│ │ └─ PgRepository.cs -│ ├─ dbsettings.json +│ │ └─ GenericRepository.cs +├─ EOM.TSHotelManagement.Migration +│ ├─ EOM.TSHotelManagement.Migration.csproj +│ ├─ EntityBuilder.cs ├─ EOM.TSHotelManagement.Web.sln +├─ EOM.TSHotelManagement.Share +│ ├─ EOM.TSHotelManagement.Share.csproj +│ ├─ Interface ├─ EOM.TSHotelManagement.WebApi │ ├─ Controllers │ │ ├─ Business │ │ ├─ Sys -│ │ ├─ Worker -│ │ └─ Zero +│ │ ├─ Employee +│ │ └─ SystemManagement +│ │ └─ Util │ ├─ EOM.TSHotelManagement.WebApi.csproj │ ├─ EOM.TSHotelManagement.WebApi.csproj.user │ ├─ EOM.TSHotelManagement.WebApi.xml -│ ├─ MvcOptionsExtensions.cs │ ├─ Program.cs -│ ├─ RouteConvention.cs -│ ├─ Router_Extension │ ├─ Startup.cs │ ├─ appsettings.Development.json │ ├─ appsettings.json -- Gitee