docs: update README

README.md

@@ -2,115 +2,136 @@
 <p align="center">
   <a href="https://veops.cn"><img src="docs/images/logo.png" alt="维易CMDB" width="300"/></a>
 </p>
-<h3 align="center">简单、轻量、通用的运维配置管理数据库</h3>
+<h4 align="center">简单、轻量、通用的运维配置管理数据库</h4>
+
 <p align="center">
   <a href="https://github.com/veops/cmdb/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-AGPLv3-brightgreen" alt="License: GPLv3"></a>
   <a href="https:https://github.com/sendya/ant-design-pro-vue"><img src="https://img.shields.io/badge/UI-Ant%20Design%20Pro%20Vue-brightgreen" alt="UI"></a>
   <a href="https://github.com/pallets/flask"><img src="https://img.shields.io/badge/API-Flask-brightgreen" alt="API"></a>
+  <a href="https://github.com/veops/cmdb/stargazers">
+    <img src="https://img.shields.io/github/stars/veops/cmdb" alt="Stars Badge"/>
+  </a>
+  <a href="https://github.com/veops/cmdb">
+    <img src="https://img.shields.io/github/forks/veops/cmdb" alt="Forks Badge"/>
+  </a>
+</p>
+<p align="center">
+  中文(简体) · <a href="docs/README_en.md">English</a>
 </p>
-
-
-------------------------------
-
-[English](docs/README_en.md) / [中文](README.md)
-- 产品文档：https://veops.cn/docs/
-- 在线体验：<a href="https://cmdb.veops.cn" target="_blank">CMDB</a>
-  - username: demo 或者 admin
-  - password: 123456
-
-> **重要提示**: `master` 分支在开发过程中可能处于 _不稳定的状态_ 。
-> 请通过[releases](https://github.com/veops/cmdb/releases)获取
 
 ## 系统介绍
 
-### 系统概览
+维易CMDB是一个简洁、轻量且高度可定制的运维配置管理数据库（CMDB）。它支持灵活的模型配置和资源自动发现，旨在为企业提供便捷的资产管理解决方案，帮助运维团队高效地管理 IT 基础设施和服务。
 
-<img src=docs/images/dashboard.png />
-
-
-### 相关文章
-
-- <a href="https://mp.weixin.qq.com/s/v3eANth64UBW5xdyOkK3tg" target="_blank">概要设计</a>
-- <a href="https://github.com/veops/cmdb/tree/master/docs/cmdb_api.md" target="_blank">API 文档</a>
-- <a href="https://mp.weixin.qq.com/s/rQaf4AES7YJsyNQG_MKOLg" target="_blank">自动发现</a>
-- 更多文章可以在公众号 **维易科技OneOps** 里查看
-
-### 特点
-
-- 灵活性
-  1. 配置灵活，不设定任何运维场景，有内置模板
-  2. 自动发现、入库 IT 资产
-- 安全性
-  1. 细粒度权限控制
-  2. 完备操作日志
-- 多应用
-  1. 丰富视图展示维度
-  2. API简单强大
-  3. 支持定义属性触发器、计算属性
+- 产品文档：[https://veops.cn/docs/](https://veops.cn/docs/)
+- 在线体验：[https://cmdb.veops.cn](https://cmdb.veops.cn)
+  - 用户名：demo 或者 admin
+  - 密码：123456
+- **重要提示**：`master` 分支在开发过程中可能处于**不稳定的状态**。请通过 [releases](https://github.com/veops/cmdb/releases) 获取最新稳定版本。
 
 ### 主要功能
 
-- 自定义模型和模型关系，模型属性支持下拉列表、字体颜色、计算属性等高级特性
-- 支持计算机、网络设备、存储设备、数据库、中间件、公有云资源等自动发现
-- 支持资源、层级、关系视图展示
-- 细粒度访问控制，完备的操作日志
-- 通用的资源搜索和关系搜索
-- 支持IP地址管理(IPAM), 数据中心基础设施管理(DCIM)
+- **自定义模型和模型关系**：支持模型属性的自定义，包括下拉列表、字体颜色、计算属性等高级功能，满足不同业务需求。
+- **自动发现资源**：支持计算机、网络设备、存储设备、数据库、中间件、公有云资源等自动发现。
+- **多维度视图展示**：包括资源视图、层级视图、关系视图等，帮助运维人员全面管理资源。
+- **细粒度权限控制**：通过精确的访问控制和完备的操作日志保障系统的安全性。
+- **全面的资源搜索功能**：支持灵活的资源和关系搜索，快速定位和操作资源。
+- **集成 IP 地址管理（IPAM）和数据中心基础设施管理（DCIM）功能**：简化网络资源和数据中心设备的管理。
+
+更多详细功能，请移步 [维易科技官网](https://veops.cn) 进行了解。
+
+### 系统特点
+
+- 灵活性
+  + 无需指定固定运维场景，支持自由配置并内置多种模板
+  + 支持自动发现和入库 IT 资产，快速搭建资产管理系统
+- 安全性
+  + 细粒度的权限控制机制，确保资源管理的安全性
+  + 完整的操作日志记录，便于审计和问题追踪
+- 多应用
+  + 提供多种视图展示方式，满足不同场景的需求
+  + 强大的 API 接口，支持深度集成
+  + 支持定义属性触发器和计算属性，增强数据处理能力
+
+### 技术栈
+
++ 后端：Python [3.8-3.11]
++ 数据存储：MySQL、Redis
++ 前端：Vue.js
++ UI组件库：Ant Design Vue
+
+### 系统概览
+
+<table style="border-collapse: collapse; border: 1px solid black;">
+  <tr>
+    <td style="padding: 5px;background-color:#fff;">
+      <img width="400" src="docs/images/cmdb-screenshot-1.png"/>
+    </td>
+    <td style="padding: 5px;background-color:#fff;">
+      <img width="400" src="docs/images/cmdb-screenshot-2.png"/>
+    </td>
+  </tr>
+
+  <tr>
+    <td style="padding: 5px;background-color:#fff;">
+      <img width="400" src="docs/images/cmdb-screenshot-3.png"/>
+    </td>
+    <td style="padding: 5px;background-color:#fff;">
+      <img width="400" src="docs/images/cmdb-screenshot-4.png"/>
+    </td>
+  </tr>
+</table>
 
 
+## 快速开始
 
-### 更多功能
+### 1. 搭建
 
-> 也欢迎移步[维易科技官网](https://veops.cn)，发现更多免费运维系统。
++ 方案一：Docker 一键快速构建
+
+  - 第1步: 安装 Docker 环境和 Docker Compose（v2）
+  - 第2步: 拷贝项目代码, `git clone https://github.com/veops/cmdb.git`
+  - 第3步：进入主目录并启动, `docker compose up -d`
+
++ 方案二：[本地开发环境搭建](docs/local.md)
++ 方案三：[Makefile 安装](docs/makefile.md)
+
+### 2. 访问
+- 打开浏览器并访问: [http://127.0.0.1:8000](http://127.0.0.1:8000)
+- 用户名: demo 或者 admin
+- 密码: 123456
 
 ## 接入公司
 
-> 欢迎使用开源CMDB的公司，在 [#112](https://github.com/veops/cmdb/issues/112) 登记
++ 欢迎使用开源CMDB的公司，在 [#112](https://github.com/veops/cmdb/issues/112) 登记
 
-## 安装
+## 代码贡献
+我们欢迎所有开发者贡献代码，改善和扩展这个项目。请先阅读我们的[贡献指南](docs/CONTRIBUTING.md)。此外，您还可以通过社交媒体、活动和分享来支持 Veops 的开源。
 
-### Docker 一键快速构建
+<a href="https://github.com/veops/cmdb/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=veops/cmdb" />
+</a>
 
-[//]: # (> 方法一)
-- 第一步: 先安装 Docker 环境, 以及Docker Compose (v2)
-- 第二步: 拷贝项目
-```shell 
-git clone https://github.com/veops/cmdb.git
-```
-- 第三步：进入主目录，执行:
-```
-docker compose up -d
-```
+## 企业版
+相比于社区版，维易企业版为企业提供了大量增强功能及技术支持服务，增强功能包括数据合规、数据级联、自动发现扩展、大屏定制等。[企业版详细介绍](https://veops.cn/cmdb)
 
-[//]: # (> 方法二, 该方法适用于linux系统)
+## 维易科技的其他开源项目
 
-[//]: # (- 第一步： 先安装 Docker 环境, 以及Docker Compose &#40;v2&#41;)
+- [OneTerm](https://github.com/veops/oneterm): 一款简单、轻量、灵活的堡垒机服务。
+- [messenger](https://github.com/veops/messenger): 一个简单轻量的消息发送服务。
+- [ACL](https://github.com/veops/acl): 一个简单通用的权限管理系统设计与实践。
+- [ops-tools](https://github.com/veops/ops-tools): 运维的一些常用实践和代码。
 
-[//]: # (- 第二步： 直接使用项目根目录下的install.sh 文件进行 `安装`、`启动`、`暂停`、`查状态`、`删除`、`卸载`)
+## 相关文章
 
-[//]: # (```shell)
+- <a href="https://mp.weixin.qq.com/s/v3eANth64UBW5xdyOkK3tg" target="_blank">尽可能通用的运维CMDB的设计与实践(Ⅰ) - 概览</a>
+- <a href="https://mp.weixin.qq.com/s/rQaf4AES7YJsyNQG_MKOLg" target="_blank">尽可能通用的运维CMDB的设计与实践(ⅠⅠ) - 自动发现</a>
+- <a href="https://github.com/veops/cmdb/tree/master/docs/cmdb_api.md" target="_blank">CMDB接口文档</a>
 
-[//]: # (curl -so install.sh https://raw.githubusercontent.com/veops/cmdb/deploy_on_kylin_docker/install.sh)
+更多文章可以在公众号 **维易科技OneOps** 里查看
 
-[//]: # (sh install.sh install)
+## 与我联系
 
-[//]: # (```)
-
-### [本地开发环境搭建](docs/local.md)
-
-### [Makefile 安装](docs/makefile.md)
-
-## 验证
-- 浏览器打开: [http://127.0.0.1:8000](http://127.0.0.1:8000)
-- username: demo 或者 admin
-- password: 123456
-
-
----
-
-_**欢迎关注公众号(维易科技OneOps)，关注后可加入微信群，进行产品和技术交流。**_
-
-
-<p align="center">
-  <img src="docs/images/wechat.png" alt="公众号: 维易科技OneOps" />
-</p>
++ 邮箱: <a href="mailto:bd@veops.cn">bd@veops.cn</a>
++ 公众号：**维易科技OneOps**。关注后可以加入微信群，参与产品和技术交流  
+  <img src="docs/images/wechat.png" alt="公众号: 维易科技OneOps" />

docs/CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# 🎉 Contributing to CMDB 🥳
+
+首先，非常感谢您考虑为我们的项目做出贡献！我们欢迎任何形式的贡献，无论是提出新功能、改进代码、修复 bug 还是改善文档。
+
+本指南将为您提供所有相关信息，帮助您快速入门并开始参与本项目。请花几分钟阅读它，它将帮助我们更好地协作，共同创造一个更好的项目。
+
+## ❖ 提交问题 (Issue)
+
+在提交 PR 之前，请先搜索 现有的 [PR](https://github.com/veops/cmdb/pulls) 或 [Issue](https://github.com/veops/cmdb/issues)，查看是否已经有相关的开放或关闭的提交。
+
+如果是修复 bug，请首先提交一个 Issue。
+
+对于新增功能，请先通过我们提供的联系方式与我们直接联系，以便更好的合作。
+
+## ❖ 提交 PR 的步骤
+
+1. 在 Github 上 fork 该项目的仓库。
+2. 在本地复制仓库后创建一个新分支，用于开发新功能、修复 bug 或进行其他贡献，命令：`git checkout -b feat/xxxx`。
+3. 提交您的更改：`git commit -am 'feat: add xxxxx'`。
+4. 推送您的分支：`git push origin feat/xxxx`。
+5. 提交 Pull Request 时，请确保您的源分支是刚刚推送的分支，目标分支是 CMDB 项目的 master 分支。
+6. 提交后，请留意与 Pull Request 相关的邮件和通知。待通过审核后，我们会按计划将其合并到 master 分支，并进行新一轮的版本发布。
+
+## ❖ 开发环境
+- Python 版本 >= 3.8
+- Node.js 版本 >= 14.17.6
+- Docker
+
+## ❖ 代码风格
+
+**API**: 请遵循 [Python Style](https://google.github.io/styleguide/pyguide.html) 
+
+**UI**: 请遵循 [node-style-guide](https://github.com/felixge/node-style-guide)
+
+## ❖ 提交信息
+
++ 请遵循 [Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
+
++ 提交时使用不同的范围
+  - API: `feat(api): xxx`
+  - UI: `feat(ui): xxx`
+
++ 为了确保所有开发者都能更好地理解，提交信息请使用英文。
+
+  - `feat` 添加新功能
+  - `fix` 修复问题/BUG
+  - `style` 代码风格相关，不影响运行结果
+  - `perf` 优化/性能提升
+  - `refactor` 代码重构
+  - `revert` 撤销编辑
+  - `test` 测试相关
+  - `docs` 文档/注释
+  - `chore` 依赖更新/脚手架配置修改等
+  - `workflow` 工作流优化
+  - `ci` 持续集成
+  - `types` 类型定义文件变更
+  - `wip` 开发中
+
+## ❖ 代码内容
+
+为了便于所有开发者理解，请确保代码注释和代码内容使用英文。

docs/CONTRIBUTING_en.md

@@ -0,0 +1,61 @@
+# 🎉 Contributing to CMDB 🥳
+
+First of all, thank you very much for considering contributing to our project! We welcome any kind of contribution, whether it's proposing new functional features, improving code, fixing bugs, or improving documentation.
+
+This guide will provide all the relevant information to help you get started working on this project. Please take a few minutes to read it, it will help us collaborate better and create a better project together.
+
+## ❖ Submit Issue
+
+Before jumping into a PR be sure to search [existing PRs](https://github.com/veops/cmdb/pulls) or [issues](https://github.com/veops/cmdb/issues) for an open or closed item that relates to your submission.
+
+If it's a bug fix, please raise it in an Issue first.
+
+For new feature additions, please first contact us directly via the contact information we provide.
+
+## ❖ Pull Requests Steps
+
+1. Fork this project's repo on Github
+2. Create a new branch on your local copy to develop new features, fix bugs, or make other contributions, `git checkout -b feat/xxxx`
+3. Submit your changes: `git commit -am 'feat: add xxxxx'`
+4. Push your branch: `git push origin feat/xxxx`
+5. To submit a `Pull Request`, make sure your source branch is the one you just pushed, and your target branch is the `master` branch of the CMDB project.
+6. After submitting, watch out for emails and notifications associated with the Pull request. Once it's approved, we'll merge it into the `master` branch as planned. Doing a new round of releases
+
+## ❖ Development Environment
+- Python >= 3.8
+- node >= 14.17.6
+- docker
+
+## ❖ Code Style
+
+**API**: Please follow the [Python Style](https://google.github.io/styleguide/pyguide.html)
+
+**UI**: Please follow the [node-style-guide](https://github.com/felixge/node-style-guide)
+
+## ❖ Commit Messages
+
++ Please follow the [Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
+
++ Commit with different scopes
+  - API: `feat(api): xxx`
+  - UI: `feat(ui): xxx`
+
++ Please keep the commit message in English for better understanding by all developers.
+
+  - `feat` Add new features
+  - `fix` Fix the problem/BUG
+  - `style` The code style is related and does not affect the running result
+  - `perf` Optimization/performance improvement
+  - `refactor` Refactor
+  - `revert` Undo edit
+  - `test` Test related
+  - `docs` Documentation/notes
+  - `chore` Dependency update/scaffolding configuration modification etc.
+  - `workflow` Workflow improvements
+  - `ci` Continuous integration
+  - `types` Type definition file changes
+  - `wip` In development
+
+## ❖ Code Content
+
+Please keep the code comments and code content in English for better understanding by all developers.

docs/README_en.md

@@ -4,98 +4,120 @@
   <a href="https://github.com/veops/cmdb/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-AGPLv3-brightgreen" alt="License: GPLv3"></a>
   <a href="https:https://github.com/sendya/ant-design-pro-vue"><img src="https://img.shields.io/badge/UI-Ant%20Design%20Pro%20Vue-brightgreen" alt="UI"></a>
   <a href="https://github.com/pallets/flask"><img src="https://img.shields.io/badge/API-Flask-brightgreen" alt="API"></a>
+  <a href="https://github.com/veops/cmdb/stargazers">
+    <img src="https://img.shields.io/github/stars/veops/cmdb" alt="Stars Badge"/>
+  </a>
+  <a href="https://github.com/veops/cmdb">
+    <img src="https://img.shields.io/github/forks/veops/cmdb" alt="Forks Badge"/>
+  </a>
 </p>
 
+<p align="center">
+  English · <a href="../README.md">中文(简体)</a>
+</p>
 
-------------------------------
+## Introduce 
+VE CMDB is a simple, lightweight and highly customizable operations and maintenance configuration management database (CMDB). It supports flexible model configuration and resource auto-discovery, and is designed to provide organizations with a convenient asset management solution that helps operations teams efficiently manage IT infrastructure and services.
 
-[English](README_en.md) / [中文](../README.md)
-
-## DEMO ONLINE
-- Product document：https://veops.cn/docs/
-- Preview online: <a href="https://cmdb.veops.cn" target="_blank">CMDB</a>
+- Product document：[https://veops.cn/docs/](https://veops.cn/docs/)
+- Preview online: [https://cmdb.veops.cn](https://cmdb.veops.cn)
   - username: demo
   - password: 123456
-
-> **ATTENTION**: branch `master` may be unstable as the result of continued development, please pull code from [releases](https://github.com/veops/cmdb/releases)
-
-## Overview
-
+- **ATTENTION**: branch `master` may be unstable as the result of continued development, Please use [releases](https://github.com/veops/cmdb/releases) to get the latest stable version
 
 ### Features
 
+- **Custom Model and Model Relationships**: Supports customization of model attributes, including drop-down lists, font colors, calculated attributes and other advanced functions to meet different business needs.  
+- **Auto-discovery of resources**: supports auto-discovery of computers, network devices, storage devices, databases, middleware, public cloud resources, etc.
+- **Multi-dimensional view display**: including resource view, hierarchical view, relationship view, etc., helping O&M personnel to comprehensively manage resources.
+- **Fine-grained privilege control**: ensure system security through precise access control and complete operation logs.
+- **Comprehensive Resource Search Function**: Supports flexible resource and relationship search to quickly locate and operate resources.
+- **Integrated IP Address Management (IPAM) and Data Center Infrastructure Management (DCIM) features**: Simplify the management of network resources and data center equipment.
+
+For more detailed features, please visit the [official website](https://veops.cn).
+
+### System Characteristics
+
 - Flexibility
-  1. Standardize and manage complex data assets
-  2. Automatically discover and inventory IT assets
+  + No need to specify fixed operation and maintenance scenarios, supports free configuration and built-in multiple templates.
+  + Support automatic discovery and inventory of IT assets, quickly set up an asset management system.
 - Security
-  1. Fine-grained access control
-  2. Comprehensive operation logs
+  + Fine-grained permission control mechanism to ensure the security of resource management.
+  + Complete operation logs for easy auditing and problem tracking.
 - Multi-application
-  1. Rich view display dimensions
-  2. Provide Restful API
-  3. Custom field triggers
+  + Provides multiple views to meet the needs of different scenarios.
+  + Powerful API interface supports deep integration.
+  + Support for defining attribute triggers and calculating attributes to enhance data processing capabilities.
 
-### Main Features
+### Tech Stack
 
-- Custom models and model relationships, with model attributes supporting advanced features such as dropdown lists, font colors, and computed attributes.
-- Support for automatic discovery of computers, network devices, storage devices, databases, middleware, public cloud resources, etc.
-- Support for displaying resource, hierarchy, and relationship views.
-- Fine-grained access control and comprehensive operation logs.
-- General resource and relationship search capabilities.
-- Support for IP Address Management (IPAM) and Data Center Infrastructure Management (DCIM).
++ Back-end: Python [3.8-3.11].
++ Data Storage: MySQL, Redis
++ Front-end: Vue.js
++ UI component library: Ant Design Vue
 
+### Overview
 
+<table style="border-collapse: collapse; border: 1px solid black;">
+  <tr>
+    <td style="padding: 5px;background-color:#fff;">
+      <img width="400" src="./images/cmdb-screenshot-1.png"/>
+    </td>
+    <td style="padding: 5px;background-color:#fff;">
+      <img width="400" src="./images/cmdb-screenshot-2.png"/>
+    </td>
+  </tr>
 
-### More Features
+  <tr>
+    <td style="padding: 5px;background-color:#fff;">
+      <img width="400" src="./images/cmdb-screenshot-3.png"/>
+    </td>
+    <td style="padding: 5px;background-color:#fff;">
+      <img width="400" src="./images/cmdb-screenshot-4.png"/>
+    </td>
+  </tr>
+</table>
 
-> Welcome to visit VeOps official website to discover more free operations and maintenance systems.
+## Quick Start
 
-## Installation
+### 1. Set up
 
-### One-Click Docker Quick Build
++ Option 1: Docker One-Click Quick Builds
 
-[//]: # (> Method 1)
-- step 1: **Prepare: install Docker and Docker Compose (v2)**
-- step 2:  copy the repository
-```shell 
-git clone https://github.com/veops/cmdb.git
-```
-- step 3: In directory cmdb:
-```
-docker compose up -d
-```
+  - Step 1: Install Docker environment and Docker Compose (v2)
+  - Step 2: Copy the project code, `git clone https://github.com/veops/cmdb.git`
+  - Step 3: Enter the home directory and start, `docker compose up -d`
 
-[//]: # (> M**ethod 2  Usefull for linux os.)
++ [Local Setup](local_en.md)
++ [Installation with Makefile](makefile_en.md)
 
-[//]: # (- step 1: **Prepare: install Docker and Docker Compose &#40;v2&#41;**)
+### 2. Visit
+- Open your browser and visit: [http://127.0.0.1:8000](http://127.0.0.1:8000)
+- Username: demo or admin
+- Password: 123456
 
-[//]: # (- step 2: directly use the install.sh file in the project's root directory to `install`, `start`, `pause`, `status`, `delete`, and `uninstall` the application. )
+## Access Company
 
-[//]: # (```shell)
-
-[//]: # (curl -so install.sh https://raw.githubusercontent.com/veops/cmdb/master/install.sh )
-
-[//]: # (sh install.sh install)
-
-[//]: # (```**)
-
-
-### [Local Setup](local_en.md)
-
-### [Installation with Makefile](makefile_en.md)
-
-## Validation
-
-- View: [http://127.0.0.1:8000](http://127.0.0.1:8000)
-- username: demo or admin
-- password: 123456
++ Companies using the open source CMDB are welcome to record in [#112](https://github.com/veops/cmdb/issues/112)
 
 ## Contributing
+We welcome all developers to contribute code to improve and extend this project. Please read our [contribution guidelines](./CONTRIBUTING_en.md) first. Additionally, you can support Veops open source through social media, events, and sharing.
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-feature`)
-5. Create new Pull Request
+<a href="https://github.com/veops/cmdb/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=veops/cmdb" />
+</a>
 
----
+## Enterprise Edition
+
+Compared to the Community Edition, VE Enterprise Edition provides a large number of enhancements and technical support services for enterprises. Enhancements include data compliance, data cascading, auto-discovery extensions, large screen customization, and more. [Enterprise Edition Details](https://veops.cn/cmdb)
+
+## VE Technology's other open source projects
+
+- [OneTerm](https://github.com/veops/oneterm): Provide secure access and control over all infrastructure.
+- [messenger](https://github.com/veops/messenger): A simple and lightweight message sending service.
+- [ACL](https://github.com/veops/acl): A general permission control management system.
+- [ops-tools](https://github.com/veops/ops-tools): Common practices and code for operations and maintenance.
+
+## Contact me
+
++ Email: <a href="mailto:bd@veops.cn">bd@veops.cn</a>