docs: readme

xooooooooox · Dec 18, 2024 · 25bef9f · 25bef9f
1 parent 5124645
commit 25bef9f
Show file tree

Hide file tree

Showing 3 changed files with 121 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# RADP
+# RADP - Rapid Application Development Platform
 
 ```text
  ███████████     █████████   ██████████   ███████████ 
@@ -11,12 +11,49 @@
 ░░░░░   ░░░░░ ░░░░░   ░░░░░ ░░░░░░░░░░   ░░░░░        
 ```
 
-## Quick Start
+[![GitHub License](https://img.shields.io/github/license/xooooooooox/radp?style=for-the-badge)](LICENSE)
 
-本项目默认使用 Maven 来构建, 最快的使用方式是 `git clone` 到本地, 然后执行以下命令:
+[[English]](./README.md)  [[中文文档]](./README_CN.md) [[Documentation]](https://xooooooooox.github.io/radp)
 
-```shell
-./mvnw clean install -T 4C -DskipTests
-```
+## Introduction
+
+RADP is a one-stop solution designed to streamline enterprise-level development. By standardizing dependencies,
+integrating common components, and providing out-of-the-box tooling, RADP significantly reduces development complexity
+and maintenance overhead.
+
+## Features
+
+- **Unified Dependency Management & Plugin Wrappers**: RADP manages library versions centrally to prevent dependency conflicts and encapsulates frequently used Maven plugins.
+This ensures consistent builds and frees developers from the tedium of managing complex build configurations.
+- **Common Components Integration**: Built upon the Spring ecosystem, RADP integrates and extends several essential components:
+  - XxlJob for distributed scheduling
+  - CAT for application performance monitoring
+  - Netty for high-performance network communication
+  - Arthas for diagnostics and troubleshooting
+- **Extensible Adaptation Layers**: RADP offers abstract layers and integration points for mainstream enterprise technologies:
+  - Message Queues (e.g., Kafka, RabbitMQ)
+  - Caching frameworks and multi-level caching strategies
+  - SMS Platforms
+  - Email Integrations
+  - Excel Handling for importing, exporting, and processing data
+- **Scaffolding & Architecture Templates**: RADP provides scaffolding tools and recommended architectural patterns to jumpstart development:
+  - DDD (Domain-Driven Design) and MVC application templates
+  - Unified coding standards and pipeline orchestration
+  - Simplified DevOps workflows and CI/CD integration
+
+## Contributing
+
+> Thanks to following people who contributed to this project. 🎉🎉🙏🙏
+
+<a href="https://github.com/xooooooooox/radp/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=xooooooooox/radp" />
+</a>
+
+## Star History
+
+![Star History Chart](https://api.star-history.com/svg?repos=xooooooooox/radp&type=Date)
+
+## COPYRIGHT
 
-_说明: 建议使用工程内置的 `maven wrapper` 即 `mvnw` 或 `mvnw.cmd` 来进行项目的构建._
+[GNU General Public License](./LICENSE) - Copyright (C) 2024 xooooooooox
+and [contributors](https://github.com/xooooooooox/radp/graphs/contributors)
diff --git a/README_CN.md b/README_CN.md
@@ -0,0 +1,76 @@
+# RADP
+
+```text
+ ███████████     █████████   ██████████   ███████████ 
+░░███░░░░░███   ███░░░░░███ ░░███░░░░███ ░░███░░░░░███
+ ░███    ░███  ░███    ░███  ░███   ░░███ ░███    ░███
+ ░██████████   ░███████████  ░███    ░███ ░██████████ 
+ ░███░░░░░███  ░███░░░░░███  ░███    ░███ ░███░░░░░░  
+ ░███    ░███  ░███    ░███  ░███    ███  ░███        
+ █████   █████ █████   █████ ██████████   █████       
+░░░░░   ░░░░░ ░░░░░   ░░░░░ ░░░░░░░░░░   ░░░░░        
+```
+
+[[English]](./README.md)  [[中文文档]](./README_CN.md) [[完整文档]](https://xooooooooox.github.io/radp)
+
+## 介绍
+
+RADP 快速开发平台：致力于提供企业开发的一站式解决方案。
+
+## 特性
+
+- **依赖管理和插件封装**：统一管理依赖版本，解决依赖冲突问题，并提供常用 Maven 插件的封装，让开发者减少在构建工具所消耗的时间。
+- **常用组件集成与封装**：在 Spring 官方的基础上扩展，提供 `XxlJob`，`CAT`，`Netty`，`Arthas` 等组件的集成。
+- **组件适配及扩展点**：针对现有主流技术点进行高级抽象，提供 `消息队列`，`缓存`，`短信平台`，`邮件`，`Excel` 等组件的集成。
+- **通用场景解决方案**：提供 `多级缓存`，`分布式锁`，`分布式唯一 ID`，`幂等性处理`，`业务流程编排`，`最终一致性`，`全链路标记`，
+  `脱敏` 等解决方案工具。
+- **脚手架封装**：提供 DDD 应用架构，MVC 应用架构等脚手架，统一开发者的编码风格, 封装流水线编排, 简化工程 DevOPS 化过程等
+
+## 介绍
+
+RADP 是一个面向企业级开发的一站式解决方案。通过对依赖的标准化管理、通用组件的整合以及开箱即用的工具支持，RADP
+显著降低了开发的复杂性和后期维护成本。
+
+## 特性
+
+- **统一的依赖管理与插件封装**:  
+  RADP 对常用库版本进行集中化管理，避免依赖冲突，并对常用的 Maven 插件进行封装。  
+  这不仅确保构建过程的一致性，还能解放开发者，让他们不必再为复杂的构建配置而烦恼。
+
+- **通用组件整合**：
+  基于 Spring 生态，RADP 集成并扩展了多种企业级必备组件：
+    - **XxlJob**：分布式任务调度
+    - **CAT**：应用性能监控
+    - **Netty**：高性能网络通信
+    - **Arthas**：诊断与故障排查
+
+- **可扩展的适配层**：  
+  RADP 提供适配主流企业技术的抽象层和扩展接口：
+    - 消息队列（如 Kafka、RabbitMQ）
+    - 缓存框架及多级缓存策略
+    - 短信平台对接
+    - 邮件集成
+    - Excel 数据导入、导出与处理
+
+- **脚手架与架构模板**：  
+  RADP 提供完善的脚手架工具和推荐的架构模式，帮助团队快速启动项目：
+    - DDD（领域驱动设计）和 MVC 应用模板
+    - 统一的编码规范和流水线编排
+    - 简化的 DevOps 工作流与 CI/CD 集成
+
+## 贡献者
+
+> 感谢以下贡献者对本项目的贡献。🎉🎉🙏🙏
+
+<a href="https://github.com/xooooooooox/radp/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=xooooooooox/radp" />
+</a>
+
+## Star History
+
+![Star History Chart](https://api.star-history.com/svg?repos=xooooooooox/radp&type=Date)
+
+## COPYRIGHT
+
+[GNU General Public License](./LICENSE) - Copyright (C) 2024 xooooooooox
+and [contributors](https://github.com/xooooooooox/radp/graphs/contributors)
diff --git a/Writerside/topics/9_faq.md b/Writerside/topics/9_faq.md
@@ -121,6 +121,7 @@ Caused by: java.lang.ClassNotFoundException: com.x9x.radp.extension.ExtensionLoa
 	at org.junit.platform.commons.util.ReflectionUtils.tryToLoadClass(ReflectionUtils.java:748)
 	... 32 more
 ```
+{collapsible="true" collapsed-title="org.junit.platform.commons.JUnitException: TestEngine with ID 'spock' failed to discover tests"}
 
 #### 原因