Skip to content

Commit

Permalink
docs:修改readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ClearXs committed Dec 22, 2023
1 parent 2dda1be commit 5cd6337
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 21 deletions.
86 changes: 86 additions & 0 deletions README.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
English | [简体中文](./README.md)

<img src="./docs/logo.png" >

<h2 align="center">Simple · Practical · Leading Edge · Innovation</h2>

<h4 align="center">The latest technologies within the Java and React ecosystems are well-suited for an all-encompassing
solution catering to enterprise-level needs and internet marketing."</h4>

## Background

Turbo is positioned as a rapid development framework built on cutting-edge technologies. Its core aim is to
differentiate itself from commonly used technological frameworks in the market, creating a one-stop solution tailored
for enterprise-level and internet marketing needs, aligning with future trends.

## Target

- 🧃 Developer-friendly, clear code, and high readability.
- 🤖 Reducing operational costs, embracing cloud-native approaches comprehensively, supporting CI/CD, and implementing
robust system monitoring solutions.
- 💪 An all-encompassing solution covering App, iOS, Mini Programs, HarmonyOS, and desktop applications within the entire
ecosystem.
- ❤️User-oriented, featuring minimalist design to reduce redundant actions, increase efficiency, and prevent repetitive
user experiences for enhanced usability.

## Proposed technical architecture (temporary)

<img src="./docs/images/Turbo-Turbo-Architecture.png">

## Technological framework (temporary)

### Back-end

1. JDK21+
2. springboot:3.2+
3. [uno:1.5+](https://github.com/ClearXs/uno)
4. mybatis-plus:3.5.3+
5. postgresql:14+
6. mysql:8+
7. opentelemetry
8. openobserve
9. redis:7+
10. kafka:3.0+
11. xxljob

### Front-end

1. [React](https://zh-hans.react.dev/)
2. [Typescript](https://www.typescriptlang.org/)
3. [Semui](https://semi.design/)
4. [tailwindcss](https://tailwindcss.com/)
5. [vite](https://vitejs.dev/)
6. [react-router](https://reactrouter.com/en/main)
7. [recoil](https://recoiljs.org/)
8. [axis](https://axios-http.com/)

### Mobile-end

1. [React](https://zh-hans.react.dev/)
2. [Taro](https://docs.taro.zone/)
3. [nutui](https://nutui.jd.com/#/)
4. sass
5. [react-router](https://reactrouter.com/en/main)
6. [react-redux](https://react-redux.js.org/)

### Desktop-end

## preview

<table>
<tr>
<td><img src="./docs/images/preview1.png" alt="preview1"/></td>
<td><img src="./docs/images/preview2.png" alt="preview2"/></td>
<td><img src="./docs/images/preview3.png" alt="preview3"/></td>
</tr>
<tr>
<td><img src="./docs/images/preview4.png" alt="preview4"/></td>
<td><img src="./docs/images/preview5.png" alt="preview5"/></td>
<td><img src="./docs/images/preview6.png" alt="preview6"/></td>
</tr>
<tr>
<td><img src="./docs/images/preview7.png" alt="preview7"/></td>
<td><img src="./docs/images/preview8.png" alt="preview8"/></td>
</tr>
</table>

33 changes: 12 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,26 @@
[English](README.en-US.md) | 简体中文


<h1 align="center">Turbo</h1>

<img src="./docs/logo.png" >
<h2 align="center">简约 · 实用 · 前沿 · 创新</h2>

<h4 align="center">基于Java体系,React体系最新技术适合于企业级与互联网营销的一站式解决方案</h4>

## 背景

### 为什么出现Turbo

Turbo的定位是以最新技术来构建的一套快速开发框架,出发点是区别于市面上通用的技术体系,打造一套适合于未来趋势的企业级已经互联网营销的一站式解决方案。


Turbo的定位是以最新技术来构建的一套快速开发框架,出发点是区别于市面上通用的技术体系,打造一套适合于未来趋势的企业级以及互联网营销的一站式解决方案。

Turbo融合各种轻量级的组件进行构建出一套:
## 目标

- 对开发人员友好,代码清晰,可读性强。
- 减少运维成本,全面拥抱云原生,支持CI/CD以及完善的系统监控方案。
- 全生态解决方案,App、IOS、小程序、鸿蒙、桌面应用
- 对用户实用,简约风的设计、减少冗余操作,增加快捷操作,避免出现重复操作等带来用户差体验
- 🧃 对开发人员友好,代码清晰,可读性强。
- 🤖 减少运维成本,全面拥抱云原生,支持CI/CD以及完善的系统监控方案。
- 💪 全生态解决方案,App、IOS、小程序、鸿蒙、桌面应用
- ❤️ 对用户实用,简约风的设计、减少冗余操作,增加快捷操作,避免出现重复操作等带来用户差体验



## 架构
## 技术架构(暂定)

<img src="./docs/images/Turbo-Turbo-Architecture.png">

## 技术体系
## 技术体系(暂定)

### 后端技术体系

Expand All @@ -37,14 +30,12 @@ Turbo融合各种轻量级的组件进行构建出一套:
4. mybatis-plus:3.5.3+
5. postgresql:14+
6. mysql:8+
7. openobserve
8. skywalking
7. opentelemetry
8. openobserve
9. redis:7+
10. kafka:3.0+
11. xxljob



### 前端技术体系

1. 语言:[React](https://zh-hans.react.dev/)
Expand Down
Binary file added docs/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5cd6337

Please sign in to comment.