feat: add architecture layers (#1860)

* feat: add architecture layers * feat: add architecture layers * feat: add architecture layers * feat: add .gitignore file * feat: add .gitignore file * feat: fix openim logs and ci * feat: fix openim logs and ci * feat: support openim readme docs Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * Update main.go --------- Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>
openimsdk · Feb 2, 2024 · af878a9 · af878a9
1 parent f551b50
commit af878a9
Show file tree

Hide file tree

Showing 38 changed files with 346 additions and 1,742 deletions.
diff --git a/CONTRIBUTING-zh_CN.md b/CONTRIBUTING-zh_CN.md
@@ -0,0 +1,33 @@
+# How do I contribute code to OpenIM
+
+<p align="center">
+  <a href="./CONTRIBUTING.md">Englist</a> · 
+  <a href="./CONTRIBUTING-zh_CN.md">中文</a> · 
+  <a href="docs/contributing/CONTRIBUTING-UA.md">Українська</a> · 
+  <a href="docs/contributing/CONTRIBUTING-CS.md">Česky</a> · 
+  <a href="docs/contributing/CONTRIBUTING-HU.md">Magyar</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ES.md">Español</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FA.md">فارسی</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FR.md">Français</a> · 
+  <a href="docs/contributing/CONTRIBUTING-DE.md">Deutsch</a> · 
+  <a href="docs/contributing/CONTRIBUTING-PL.md">Polski</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ID.md">Indonesian</a> · 
+  <a href="docs/contributing/CONTRIBUTING-FI.md">Suomi</a> · 
+  <a href="docs/contributing/CONTRIBUTING-ML.md">മലയാളം</a> · 
+  <a href="docs/contributing/CONTRIBUTING-JP.md">日本語</a> · 
+  <a href="docs/contributing/CONTRIBUTING-NL.md">Nederlands</a> · 
+  <a href="docs/contributing/CONTRIBUTING-IT.md">Italiano</a> · 
+  <a href="docs/contributing/CONTRIBUTING-RU.md">Русский</a> · 
+  <a href="docs/contributing/CONTRIBUTING-PTBR.md">Português (Brasil)</a> · 
+  <a href="docs/contributing/CONTRIBUTING-EO.md">Esperanto</a> · 
+  <a href="docs/contributing/CONTRIBUTING-KR.md">한국어</a> · 
+  <a href="docs/contributing/CONTRIBUTING-AR.md">العربي</a> · 
+  <a href="docs/contributing/CONTRIBUTING-VN.md">Tiếng Việt</a> · 
+  <a href="docs/contributing/CONTRIBUTING-DA.md">Dansk</a> · 
+  <a href="docs/contributing/CONTRIBUTING-GR.md">Ελληνικά</a> · 
+  <a href="docs/contributing/CONTRIBUTING-TR.md">Türkçe</a>
+</p>
+
+</div>
+
+</p>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -4,29 +4,51 @@
     </a>
 </p>
 
-<h3 align="center" style="border-bottom: none">
-    ⭐️  Open source Instant Messaging Server ⭐️ <br>
-<h3>
-
-
-<p align=center>
-<a href="https://goreportcard.com/report/github.com/openimsdk/open-im-server"><img src="https://goreportcard.com/badge/github.com/openimsdk/open-im-server" alt="A+"></a>
-<a href="https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22"><img src="https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?logo=%22github%22" alt="good first"></a>
-<a href="https://github.com/openimsdk/open-im-server"><img src="https://img.shields.io/github/stars/openimsdk/open-im-server.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a>
-<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q"><img src="https://img.shields.io/badge/Slack-300%2B-blueviolet?logo=slack&amp;logoColor=white"></a>
-<a href="https://github.com/openimsdk/open-im-server/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green"></a>
-<a href="https://golang.org/"><img src="https://img.shields.io/badge/Language-Go-blue.svg"></a>
-</p>
+<div align="center">
+
+[![Stars](https://img.shields.io/github/stars/openimsdk/open-im-server?style=for-the-badge&logo=github&colorB=ff69b4)](https://github.com/openimsdk/open-im-server/stargazers)
+[![Forks](https://img.shields.io/github/forks/openimsdk/open-im-server?style=for-the-badge&logo=github&colorB=blue)](https://github.com/openimsdk/open-im-server/network/members)
+[![Codecov](https://img.shields.io/codecov/c/github/openimsdk/open-im-server?style=for-the-badge&logo=codecov&colorB=orange)](https://app.codecov.io/gh/openimsdk/open-im-server)
+[![Go Report Card](https://goreportcard.com/badge/github.com/openimsdk/open-im-server?style=for-the-badge)](https://goreportcard.com/report/github.com/openimsdk/open-im-server)
+[![Go Reference](https://img.shields.io/badge/Go%20Reference-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://pkg.go.dev/github.com/openimsdk/open-im-server/v3)
+[![License](https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge)](https://github.com/openimsdk/open-im-server/blob/main/LICENSE)
+[![Slack](https://img.shields.io/badge/Slack-500%2B-blueviolet?style=for-the-badge&logo=slack&logoColor=white)](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
+[![Best Practices](https://img.shields.io/badge/Best%20Practices-purple?style=for-the-badge)](https://www.bestpractices.dev/projects/8045)
+[![Good First Issues](https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?style=for-the-badge&logo=github)](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
+[![Language](https://img.shields.io/badge/Language-Go-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://golang.org/)
 
-</p>
 
 <p align="center">
-    <a href="./README.md"><b> English </b></a> •
-    <a href="./README-zh_CN.md"><b> 简体中文 </b></a> •
-    <a href="https://openim.io/en"><b> Docs </b></a>
+  <a href="./README.md">Englist</a> · 
+  <a href="./README-zh_CN.md">中文</a> · 
+  <a href="docs/readme/README-UA.md">Українська</a> · 
+  <a href="docs/readme/README-CS.md">Česky</a> · 
+  <a href="docs/readme/README-HU.md">Magyar</a> · 
+  <a href="docs/readme/README-ES.md">Español</a> · 
+  <a href="docs/readme/README-FA.md">فارسی</a> · 
+  <a href="docs/readme/README-FR.md">Français</a> · 
+  <a href="docs/readme/README-DE.md">Deutsch</a> · 
+  <a href="docs/readme/README-PL.md">Polski</a> · 
+  <a href="docs/readme/README-ID.md">Indonesian</a> · 
+  <a href="docs/readme/README-FI.md">Suomi</a> · 
+  <a href="docs/readme/README-ML.md">മലയാളം</a> · 
+  <a href="docs/readme/README-JP.md">日本語</a> · 
+  <a href="docs/readme/README-NL.md">Nederlands</a> · 
+  <a href="docs/readme/README-IT.md">Italiano</a> · 
+  <a href="docs/readme/README-RU.md">Русский</a> · 
+  <a href="docs/readme/README-PTBR.md">Português (Brasil)</a> · 
+  <a href="docs/readme/README-EO.md">Esperanto</a> · 
+  <a href="docs/readme/README-KR.md">한국어</a> · 
+  <a href="docs/readme/README-AR.md">العربي</a> · 
+  <a href="docs/readme/README-VN.md">Tiếng Việt</a> · 
+  <a href="docs/readme/README-DA.md">Dansk</a> · 
+  <a href="docs/readme/README-GR.md">Ελληνικά</a> · 
+  <a href="docs/readme/README-TR.md">Türkçe</a>
 </p>
 
 
+</div>
+
 </p>
 
 ## 🟢 扫描微信进群交流
@@ -39,8 +61,6 @@ OpenIM 是一个专门设计用于在应用程序中集成聊天、音视频通
 
 
 
-
-
 ![App-OpenIM 关系](./docs/images/oepnim-design.png)
 
 ## 🚀 关于 OpenIMSDK

diff --git a/README.md b/README.md
@@ -17,9 +17,35 @@
 [![Good First Issues](https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?style=for-the-badge&logo=github)](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
 [![Language](https://img.shields.io/badge/Language-Go-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://golang.org/)
 
-[**English**](./README.md) •
-[**简体中文**](./README-zh_CN.md) •
-[**Docs**](https://openim.io/en)
+
+<p align="center">
+  <a href="./README.md">Englist</a> · 
+  <a href="./README-zh_CN.md">中文</a> · 
+  <a href="docs/readme/README-UA.md">Українська</a> · 
+  <a href="docs/readme/README-CS.md">Česky</a> · 
+  <a href="docs/readme/README-HU.md">Magyar</a> · 
+  <a href="docs/readme/README-ES.md">Español</a> · 
+  <a href="docs/readme/README-FA.md">فارسی</a> · 
+  <a href="docs/readme/README-FR.md">Français</a> · 
+  <a href="docs/readme/README-DE.md">Deutsch</a> · 
+  <a href="docs/readme/README-PL.md">Polski</a> · 
+  <a href="docs/readme/README-ID.md">Indonesian</a> · 
+  <a href="docs/readme/README-FI.md">Suomi</a> · 
+  <a href="docs/readme/README-ML.md">മലയാളം</a> · 
+  <a href="docs/readme/README-JP.md">日本語</a> · 
+  <a href="docs/readme/README-NL.md">Nederlands</a> · 
+  <a href="docs/readme/README-IT.md">Italiano</a> · 
+  <a href="docs/readme/README-RU.md">Русский</a> · 
+  <a href="docs/readme/README-PTBR.md">Português (Brasil)</a> · 
+  <a href="docs/readme/README-EO.md">Esperanto</a> · 
+  <a href="docs/readme/README-KR.md">한국어</a> · 
+  <a href="docs/readme/README-AR.md">العربي</a> · 
+  <a href="docs/readme/README-VN.md">Tiếng Việt</a> · 
+  <a href="docs/readme/README-DA.md">Dansk</a> · 
+  <a href="docs/readme/README-GR.md">Ελληνικά</a> · 
+  <a href="docs/readme/README-TR.md">Türkçe</a>
+</p>
+
 
 </div>
 
@@ -68,6 +94,13 @@ It is built using Golang and supports cross-platform deployment, ensuring a cons
 
 👉 **[Learn more](https://docs.openim.io/guides/introduction/product)**
 
+## :building_construction: Overall Architecture
+
+Delve into the heart of Open-IM-Server's functionality with our architecture diagram.
+
+![Overall Architecture](./docs/images/architecture-layers.png)
+
+
 ## :rocket: Quick Start
 
 We support many platforms. Here are the addresses for quick experience on the web side：

diff --git a/docs/README.md b/docs/README.md
@@ -7,7 +7,6 @@ Welcome to the OpenIM Documentation hub! This center provides a comprehensive ra
 1. [Contrib](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib) - Guidance on contributing and configurations for developers
 2. [Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib) - Coding conventions, logging policies, and other transformation tools
 
-------
 
 ## Contrib
 

diff --git a/docs/README_ar.md b/docs/README_ar.md