Merge pull request #22 from Jzow/master

Add Readme File

README.md

@@ -1,5 +1,83 @@
-# WanSen ERP
+<h1 align="center">WanSen ERP</h1>
+<div align="center">
+ <strong>
+  Next generation intelligent AI ERP system
+ </strong>
+</div>
+<br />
 
-Next generation intelligent ERP system
+<div align="center">
+  <!-- Crates version -->
+  <a href="https://spring.io/projects/spring-boot#learn">
+    <img alt="Static Badge" src="https://img.shields.io/badge/spring-boot?label=Spring%20Boot%203.1.3">
+  </a>
+  <a href="#">
+    <img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/wansenai/wansenerp/maven.yml">
+  </a>
+  <!-- Contributors -->
+  <a href="https://github.com/wansenai/wansenerp/graphs/contributors">
+    <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/wansenai/wansenerp">
+  </a>
+  <!-- bors -->
+  <a href="#">
+    <img alt="GitHub last commit (branch)" src="https://img.shields.io/github/last-commit/wansenai/wansenerp/master">
+  </a>
+</div>
+<br />
 
-We will refer to SpringCloud technology in the future
+On the basis of ERP business, we have expanded GPT-3.5. You, individually or as a company, can fine tune your model through our system and deploy it through Docker or other methods. 
+
+You can provide fully automated business form submission operations through your simple description, and you can chat, interact, and consult information with GPT.
+
+## Online preview
+
+We have deployed this program on Amazon Cloud for you to experience before deciding to use it. 
+If you have any questions or suggestions, please submit [issue](https://github.com/wansenai/WansenERP/issues/new) and we will handle them in a timely manner.
+
+Experience address: http://140.179.135.174:3000/
+
+## Module Description
+
+1. **Domain Module:**
+
+Business Operation Data Object.
+```xml
+<dependency>
+    <groupId>com.wansensoft</groupId>
+    <artifactId>domain</artifactId>
+    <version>1.0-SNAPSHOT</version>
+</dependency>
+```
+
+2. **Dao Module:**
+
+Data Access Objects separate data access logic from business logic to provide access and operations to data persistent storage.
+```xml
+<dependency>
+    <groupId>com.wansensoft</groupId>
+    <artifactId>dao</artifactId>
+    <version>1.0-SNAPSHOT</version>
+</dependency>
+```
+
+3. **Service Module:**
+
+Business logic layer, which delegates specific business logic processing to the Service layer.
+```xml
+<dependency>
+    <groupId>com.wansensoft</groupId>
+    <artifactId>service</artifactId>
+    <version>1.0-SNAPSHOT</version>
+</dependency>
+```
+
+4. **Utils Module:**
+
+Tool class code that encapsulates some specific operations.
+```xml
+<dependency>
+    <groupId>com.wansensoft</groupId>
+    <artifactId>utils</artifactId>
+    <version>1.0-SNAPSHOT</version>
+</dependency>
+```

api/README.md

@@ -0,0 +1,22 @@
+# API Module
+
+This module is mainly used to encapsulate external request able **API(application program interfaces)**, It includes the following functions:
+
+1. account: Account management and financial management, as well as financial detail management.
+2. depot: Warehouse management and warehouse entry and exit documents.
+3. Function management (**note:** this `API` is unstable and may need to be adjusted later)
+4. Management interface for revenue and expenditure.
+5. Some management interfaces for products (product attributes, classifications) include extension interfaces.
+6. Interface for message notification management, some functions for querying messages and updating status
+7. General management of institutional organizations.
+8. Operator Management Interface.
+9. Some interfaces on the system platform side
+10. Interface related to platform role management
+11. Document number management (**note:** this interface may be integrated later and will no longer be independent as a module)
+12. Serial number management interface, similar to the same as above.
+13. The interface for supplier management, which includes the interface for querying and operating supplier data
+14. System interface, including restrictions on general file upload and download, image compression preview, etc.
+15. Interface for multiple tenant management classes.
+16. Unit management interface.
+17. User management interface and interface management that includes the corresponding relationship between users and roles.
+

api/pom.xml

@@ -62,33 +62,4 @@
         </dependency>
     </dependencies>
 
-    <build>
-        <resources>
-            <resource>
-                <directory>src/main/java</directory>
-                <includes>
-                    <include>**/*.xml</include>
-                </includes>
-            </resource>
-            <resource>
-                <directory>src/main/resources</directory>
-            </resource>
-        </resources>
-        <plugins>
-            <plugin>
-                <groupId>org.springframework.boot</groupId>
-                <artifactId>spring-boot-maven-plugin</artifactId>
-                <configuration>
-                    <finalName>wansenerp</finalName>
-                    <excludes>
-                        <exclude>
-                            <groupId>org.projectlombok</groupId>
-                            <artifactId>lombok</artifactId>
-                        </exclude>
-                    </excludes>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
-
 </project>

dao/README.md

@@ -0,0 +1,3 @@
+# Dao Module
+
+Data Access Object

domain/README.md

@@ -0,0 +1 @@
+# Domain Module

middleware/README.md

@@ -0,0 +1 @@
+# Middleware Module

plugins/README.md

@@ -0,0 +1 @@
+# Plugins Module

service/README.md

@@ -0,0 +1 @@
+# Service Module

utils/pom.xml

@@ -80,7 +80,7 @@
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
                 <configuration>
-                    <classifier>exec</classifier>
+                    <skip>true</skip>
                 </configuration>
             </plugin>
         </plugins>