From fb663786e886d262fee0ce9cddc56d8443482be9 Mon Sep 17 00:00:00 2001 From: Chunkit Yeung Date: Sat, 9 Mar 2024 17:38:02 +0800 Subject: [PATCH 1/2] update MD --- README.en.md | 135 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 12 +++-- 2 files changed, 143 insertions(+), 4 deletions(-) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..e77019a --- /dev/null +++ b/README.en.md @@ -0,0 +1,135 @@ +

Organization Logo.png

+

TopskyHotelManagerSystem

+

+ star + fork + + +

+
+

中文文档 | English Document

+
+ + +# :exclamation: Important Notice: + +**Note: The master branch changes with the v2.x version, which significantly differs from the v1.x version. Those interested in the v1.x version can move to the v1.x branch address**: https://gitee.com/java-and-net/TopskyHotelManagerSystem/tree/v1.x/ + +# :pray: Open Source Projects Referenced: + +1. ##### Fody—Packs all dlls into an exe application. [Fody, MIT License](https://github.com/Fody/Fody) + +2. ##### SQLSugar, the most popular ORM framework in China. [SQLSugar, Apache-2.0 License](https://gitee.com/dotnetchina/SqlSugar) + +3. ##### SunnyUI—SunnyUI.Net, based on C# .Net WinForm open-source control library, tool library, extension library, and multi-page development framework. [SunnyUI.Net, GPL3.0 License](https://gitee.com/yhuse/SunnyUI) + +# :exclamation: Project Description: + +1. When redeveloping this project, please follow the MIT open-source license. The SunnyUI.Net framework uses the GPL3.0 open-source license, and the SQLSugarORM framework uses the Apache2.0 license. Please be sure to include the corresponding statement in the project introduction. + +2. Bugs and comments are welcome! + +3. This system’s 95% of the pages are created based on the SunnyUI.Net control library, hereby specially declared! + +4. Regarding the database script issue, please first go to the database script folder, choose either the MySQL version or PostgreSQL version folder to download the Data and Table files. In the database, execute the Table.sql first, then the Data.sql! + +5. For MySQL and PostgreSQL databases: + + 5.1 If the local database is MySQL, please change the Repository inherited by the business logic class in the Application layer to MysqlRepository, and configure the mysqlString constant database connection string in the Common layer’s HttpHelper. + + 5.2 If the local database is PostgreSQL, no changes are needed, just configure the pgsqlString constant database connection string in the Common layer’s HttpHelper. + +# :thought_balloon: Development Purpose: + +In today's rapidly developing hotel industry, with the increase in daily hotel work, it has become difficult to handle with manpower alone. Some cumbersome data may also cause some losses to the hotel due to human errors, hence the need for a management software that can assist in the internal management of the hotel. + +# :mag_right: System Development Environment: + +Operating System: Windows 10(x64) + +Development Tools: Microsoft Visual Studio 2015 (first version of the system)/Microsoft Visual Studio 2019 (latest version of the system) + +Database: Microsoft SQL Server 2008 R2 (used in the earliest version)/MySQL v8.0.22 (highly recommended!)/PostgreSQL13 (highly recommended!) + +Database Management Tools: Microsoft SQL Server 2008 R2 Management Studio/Navicat 15 + +Programming Languages: C# language, T-SQL language + +Development Platform: .Net + +Development Framework: .Net Framework 4.5.2/.Net Framework 4.6.1 (fully upgraded) —>.Net Framework 4.7.1 + +Development Technology: .NET WinForm + +# :open_file_folder: System Structure: + +```tree +EOM.Client.TopSkyHotelManagerSystem +├─ .git +├─ .gitignore +├─ EOM.Client.TopSkyHotelManagerSystem.sln +├─ FodyWeavers.xml +├─ LICENSE +├─ README.md +├─ SYS.Common +├─ SYS.Core +├─ SYS.FormUI +│ ├─ .gitignore +│ ├─ App.config +│ ├─ AppFunction +│ ├─ AppInterface +│ ├─ AppMain +│ ├─ AppUserControls +│ ├─ FodyWeavers.xml +│ ├─ FodyWeavers.xsd +│ ├─ Logo +│ ├─ Program.cs +│ ├─ Properties +│ ├─ Resources +├─ SYS.Library +├─ Database Scripts +├─ Project Screenshots +└─ Project Related Documents +``` + +# :chart_with_upwards_trend: System Database Relationship Diagram (Generated by PDMAN Software) :loudspeaker: + +[Database Relationship Diagram](https://oscode.top/project/tshotel/db_design.html) + +# :books: Summary of System Function Modules: + +| Function Summary | | | | | | | +| ---------------------------------------- | -------------------------------- | -------------------------- | ---------------------------- | ---------------------------------- | ------------------ | ------------------ | +| (Front Desk) Room Management | Reserve Room | Check-in Room | Checkout Room | Switch Room | View Customer Info | Modify Room Status | +| (Front Desk) Customer Management | Display Customer Info | Search Customer Info | Add Customer | | | | +| (Front Desk) Product Consumption | Product List | Search Product Info | Product Consumption | Consumption Info | | | +| (Front Desk) Additional Features | None | | | | | | +| (Back Office) Basic Information | Position Type Maintenance | Ethnicity Type Maintenance | Education Type Maintenance | Department Information Maintenance | | | +| (Back Office) Financial Information | Employee Salary Bills | Internal Financial Bills | Hotel Profit Situation | | | | +| (Back Office) Utilities Management | Utilities Info | | | | | | +| (Back Office) Supervision and Statistics | Supervision Department Situation | | | | | | +| (Back Office) Room Management | Room Status Overview | Add New Room | | | | | +| (Back Office) Customer Management | Customer Information Management | Customer Consumption Bills | | | | | +| Function Summary (Continued) | | | | | | | +| (Back Office) HR Management | Employee Management | Announcement Logs | Upload Announcement Logs | | | | +| (Back Office) Material Management | Product Management | Warehouse Supplies | | | | | +| Employee Operation Logs | | | | | | | +| System Management | Add Administrator | Permission Assignment | Enable/Disable Administrator | | | | + +# :family: Project Authors: + +**Original Team: Jackson, Benjamin, Bin, Jonathan** + +**Later Maintenance Team: Easy Open Meta (易开元)** + +# :computer: Project Setup and Deployment: + +**Download and install Microsoft Visual Studio Professional 2019 or above, unzip the downloaded Zip package, and run the .sln file.** + +# :inbox_tray: Database Setup and Deployment (Local): + +**The author and development team strongly recommend using the PostgreSQL database. Install the PostgreSQL database and start the service, establish the database through a visualization management tool, and quickly create data tables and import data by opening the .sql format files within the database script folder. Steps (using PostgreSQL database as an example):** + +**1. Link to the PostgreSQL database through a visualization management tool, then create a new database named ‘tshoteldb’.** + +**2. Open the db_file.sql in the database script\PostgreSQL version folder through the visualization management tool for data table creation and data import.** diff --git a/README.md b/README.md index 6574515..ce43cbf 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ -

组织logo.png

+

Organization Logo.png

TopskyHotelManagerSystem

- star - fork - + star + fork

+
+

中文文档 | English Document

+
+ + # :exclamation: 重要说明： -- Gitee From 8473946145d20d999e47e8a6e460dfc5298d5fb3 Mon Sep 17 00:00:00 2001 From: Chunkit Yeung Date: Sat, 9 Mar 2024 17:38:09 +0800 Subject: [PATCH 2/2] add submodule --- topsky-hotel-manager-system-web-api | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/topsky-hotel-manager-system-web-api b/topsky-hotel-manager-system-web-api index 8d0f62c..84a6690 160000 --- a/topsky-hotel-manager-system-web-api +++ b/topsky-hotel-manager-system-web-api @@ -1 +1 @@ -Subproject commit 8d0f62c3e7e197cf2831c1e64eaf7658f9c7ae39 +Subproject commit 84a669090635d899e7d7d1a8611018280ba08eb0 -- Gitee