From 84a669090635d899e7d7d1a8611018280ba08eb0 Mon Sep 17 00:00:00 2001 From: Chunkit Yeung Date: Sat, 9 Mar 2024 17:38:02 +0800 Subject: [PATCH] update MD --- README.en.md | 110 +++++++++++++++++++++++++++++++++++++++------------ README.md | 5 ++- 2 files changed, 88 insertions(+), 27 deletions(-) diff --git a/README.en.md b/README.en.md index 82a827d..347c419 100644 --- a/README.en.md +++ b/README.en.md @@ -1,36 +1,96 @@ -# TopskyHotelManagerSystem-WebApi +

Organization logo.png

+

TopskyHotelManagerSystem-WebApi

+

+ star + fork + + +

+
+

中文文档 | English Document

+
-#### Description -基于Furion框架构建的TS酒店管理系统后端API项目，主要用于2.0升级所用，欢迎Start&Fork -#### Software Architecture -Software architecture description -#### Installation +### :pray: Thanks to the following open source projects: -1. xxxx -2. xxxx -3. xxxx +1. ##### Autofac——An addictive .NET IoC container. [Autofac, MIT License](https://github.com/autofac/Autofac) -#### Instructions +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) -1. xxxx -2. xxxx -3. xxxx +### :exclamation: About this project: -#### Contribution +This project is a TS hotel management system backend API project built on .Net6, mainly for the 2.0 upgrade, welcome to Star & Fork. -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request +1. All development should comply with the MIT open source license. +2. If you find bugs, feel free to raise an issue! -#### Gitee Feature +### :thought_balloon: Development purpose: -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +Mainly for upgrading the existing C/S project hotel management system to version 2.0 to achieve a WebAPI interface that separates the front end from the back end. This project does not include any UI interface. + +### :mag_right: System development environment: + +Operating System: Windows 11(x64) + +Development Tool: Microsoft Visual Studio 2022 (latest version of the system) + +Database: PostgreSQL v13 + +Database Management Tool: Navicat 16 + +Programming Language: C# language, LINQ language + +Development Platform: .Net + +Development Framework: .Net 6 + +Development Technology: .NET 6 WebAPI + +### :open_file_folder: System structure: + +``` +TopskyHotelManagerSystem +├.github +├.gitignore +├.gitmodules +├EOM.Client.TopSkyHotelManagerSystem.sln +├FodyWeavers.xml +├LICENSE +├packages +├README.md +├SYS.Common +├SYS.FormUI +├SYS.Library +├TopskyHotelManagerSystem-WebApi +├数据库脚本 +├项目效果图 +├项目相关文档 +``` + +### :chart_with_upwards_trend: System database relationship diagram (generated by PDMAN software) :loudspeaker: + +[Database Relationship Diagram](https://oscode.top/project/tshotel/db_design.html) + +### :exclamation: Project authors: + +**Jackson (i.e., this account, project leader, core code writing, and later project integration)** + +**Benjamin (Developer, project code writing)** + +**Bin (Database, providing database management support)** + +**Coffee and Network (late maintenance and development)** + +### :computer: Project deployment (before executing the steps below, you need to install .NET 6 SDK and Runtime): + +**Download and install Microsoft Visual Studio Professional 2022 or above version, unzip the Zip package, and run the file with .sln suffix to start.** + +### :inbox_tray: Database deployment (local): + +**The author and development team strongly recommend using PostgreSQL database. Install the PostgreSQL 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 PostgreSQL database as an example):** + +**1. Use a visualization management tool to open the Table.sql file to create data tables.** + +**2. Then open the Data.sql file to import data.** diff --git a/README.md b/README.md index e27bc66..8ec8c08 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@

组织logo.png

TopskyHotelManagerSystem-WebApi

- star - fork + star + fork

+ ### :pray: 感谢以下开源项目： 1. ##### Autofac——An addictive .NET IoC container。[Autofac, MIT开源协议](https://github.com/autofac/Autofac) -- Gitee