Skip to content

Commit 23c80ec

Browse files
committed
docs: ✏️ 优化文档
1 parent 834bedd commit 23c80ec

File tree

2 files changed

+150
-54
lines changed

2 files changed

+150
-54
lines changed

README.en.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# AiLowCode
2+
> Next-generation AI-powered Low-Code Development Platform
3+
4+
[![Author](https://img.shields.io/badge/Author-Axelu-orange.svg)](https://ailowcode.app)
5+
[![Version](https://img.shields.io/badge/version-In%20Development-brightgreen.svg)](https://github.com/ai-lowcode/core/releases/tag/)
6+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ai-lowcode/core/blob/master/LICENSE)
7+
[![Blog](https://img.shields.io/badge/Blog-axelu.me-yellow.svg)](https://axelu.me)
8+
9+
English | [简体中文](./README.md)
10+
11+
## 📚 Project Overview
12+
13+
AiLowCode is a modern, AI-powered low-code development platform designed to enhance development efficiency through artificial intelligence capabilities. This repository contains the frontend portion of the project. For the backend code, please visit [ai-lowcode/server](https://github.com/ai-lowcode/server).
14+
15+
### ✨ Features
16+
17+
- 🛠️ **Modern Tech Stack**: Built with Vue 3.4, Vite 5.0, Element-Plus, TypeScript
18+
- 📦 **Advanced Engineering**: Efficient package management using monorepo + pnpm + turbo
19+
- 🤖 **AI-Driven**: Deep integration of AI models, redesigning the low-code renderer from the ground up
20+
- 🎨 **Elegant Architecture**: Carefully designed modules including hooks, request, styles, types, and utils
21+
22+
## 🚀 Quick Start
23+
24+
### Prerequisites
25+
26+
- Node.js >= 16
27+
- pnpm >= 8
28+
29+
### Install Dependencies
30+
31+
```bash
32+
pnpm install
33+
```
34+
35+
### Initialize Packages
36+
37+
```bash
38+
pnpm package-init
39+
```
40+
41+
### Run the Project
42+
43+
```bash
44+
pnpm --filter "ai-lowcode-admin" "dev"
45+
```
46+
47+
## 🔧 Technology Stack
48+
49+
This project utilizes the following technologies:
50+
51+
- [Vue 3](https://v3.vuejs.org/) - Progressive JavaScript Framework
52+
- [TypeScript](https://www.typescriptlang.org/) - JavaScript with syntax for types
53+
- [Vite](https://vitejs.dev/) - Next Generation Frontend Build Tool
54+
- [Element-Plus](https://element-plus.org/) - Vue 3 Component Library
55+
- [Pinia](https://pinia.vuejs.org/) - Vue State Management Solution
56+
- [Vue Router](https://router.vuejs.org/) - Official Router for Vue.js
57+
58+
## 📸 Interface Preview
59+
60+
<details>
61+
<summary>Click to view interface previews</summary>
62+
63+
![Interface Preview](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031408.png)
64+
![Designer](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031335.png)
65+
![Component Configuration](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031638.png)
66+
</details>
67+
68+
## 🌍 Browser Support
69+
70+
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Safari |
71+
| :---: | :---: | :---: | :---: |
72+
| Latest ✅ | Latest ✅ | Latest ✅ | Latest ✅ |
73+
74+
## 🤝 Community & Support
75+
76+
### Join Our Community
77+
78+
- WeChat Group: Scan the QR code below
79+
80+
![WeChat Group](https://i.imgur.com/tD8L1B2.png)
81+
82+
- QQ Group: [718136001](https://qm.qq.com/q/YPjQJoIxqI)
83+
84+
## 📄 License
85+
86+
[MIT](./LICENSE) License © 2024 [Axelu](https://github.com/ai-lowcode)

README.md

Lines changed: 64 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,86 @@
1-
AiLowCode代码开发平台(前端)-> [后端地址](https://github.com/ai-lowcode/server)
2-
======================================
3-
当前最新版本:(开发中)
1+
# AiLowCode
2+
> 新一代 AI 驱动的低代码开发平台
43
54
[![Author](https://img.shields.io/badge/Author-Axelu-orange.svg)](https://ailowcode.app)
6-
[![Blog](https://img.shields.io/badge/Blog-个人博客-yellow.svg)](https://axelu.me)
75
[![Version](https://img.shields.io/badge/version-开发中-brightgreen.svg)](https://github.com/ai-lowcode/core/releases/tag/)
8-
[![License](https://img.shields.io/badge/license-MIT%20License-blue.svg)](https://github.com/ai-lowcode/core/blob/master/LICENSE)
6+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ai-lowcode/core/blob/master/LICENSE)
7+
[![Blog](https://img.shields.io/badge/Blog-axelu.me-yellow.svg)](https://axelu.me)
98

10-
[![GitHub watches](https://img.shields.io/github/watchers/ai-lowcode/core.svg?style=social&label=Watch)](https://github.com/ai-lowcode/core)
11-
[![GitHub stars](https://img.shields.io/github/stars/ai-lowcode/core.svg?style=social&label=Stars)](https://github.com/ai-lowcode/core)
12-
[![GitHub forks](https://img.shields.io/github/forks/ai-lowcode/core.svg?style=social&label=Fork)](https://github.com/ai-lowcode/core)
9+
[English](./README.en.md) | 简体中文
1310

14-
## 项目介绍
11+
## 📚 项目简介
1512

16-
AiLowCode代码前端采用 Vue3.4、Vite5.0、 Element-Plus、TypeScript 等新技术方案。使用当前最先进的 monorepo pnpm turbo包管理方式,changeset 包发布方式。
17-
基于当前最火热的 ai 模型,从底层重新设计 lowcode/core 低代码渲染器,重写适配于现代化的 ai 低代码设计器。
18-
且采用更合理的方式重新设计 hooks,request,styles,types,utils 等包...
13+
AiLowCode 是一个基于人工智能的现代化低代码开发平台,旨在通过 AI 能力提升开发效率。本仓库为项目的前端部分,后端代码请访问 [ai-lowcode/server](https://github.com/ai-lowcode/server)
1914

20-
## 入门必备
15+
### ✨ 特性
2116

22-
本项目需要一定前端基础知识,请确保掌握 Vue 的基础知识,以便能处理一些常见的问题。
23-
建议在开发前先学一下以下内容,提前了解和学习这些知识,会对项目理解非常有帮助:
17+
- 🛠️ **现代化技术栈**:基于 Vue 3.4、Vite 5.0、Element-Plus、TypeScript
18+
- 📦 **先进的工程化**:采用 monorepo + pnpm + turbo 实现高效的包管理
19+
- 🤖 **AI 驱动**:深度集成 AI 模型,从底层重新设计低代码渲染器
20+
- 🎨 **优雅的架构**:经过精心设计的 hooks、request、styles、types、utils 等模块
2421

25-
* [Vue3 文档](https://v3.vuejs.org/)
26-
* [TypeScript](https://www.typescriptlang.org/)
27-
* [Vue-router](https://next.router.vuejs.org/)
28-
* [Element-Plus](https://www.antdv.com/components/overview-cn)
29-
* [Es6](https://es6.ruanyifeng.com/)
30-
* [Vitejs](https://vitejs.dev/)
31-
* [Pinia(vuex替代方案)](https://pinia.esm.dev/introduction.html)
32-
* [Vue-RFCS](https://github.com/vuejs/rfcs)
22+
## 🚀 快速开始
3323

34-
## 界面参考
24+
### 环境要求
3525

36-
* [vue-pure-admin](https://github.com/pure-admin/vue-pure-admin)
26+
- Node.js >= 16
27+
- pnpm >= 8
3728

38-
## 界面预览 1
29+
### 安装依赖
3930

40-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031408.png)
41-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031335.png)
42-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031638.png)
43-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031611.png)
44-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031551.png)
45-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031538.png)
46-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031530.png)
47-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031514.png)
48-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031452.png)
49-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031443.png)
50-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031430.png)
51-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031023.png)
52-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031840.png)
53-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031800.png)
54-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031858.png)
55-
![](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031847.png)
31+
```bash
32+
pnpm install
33+
```
5634

57-
## 平台交流
35+
### 初始化 pkg
5836

59-
### 微信:
37+
```bash
38+
pnpm package-init
39+
```
6040

61-
![](https://i.imgur.com/tD8L1B2.png)
41+
### 运行项目
6242

63-
### QQ群:
43+
```bash
44+
pnpm --filter "ai-lowcode-admin" "dev"
45+
```
6446

65-
[![加入QQ群](https://img.shields.io/badge/718136001-blue.svg)](https://qm.qq.com/q/YPjQJoIxqI)
66-
点击链接加入群聊【Ai-LowCode 交流群】
47+
## 🔧 技术栈
6748

68-
## 浏览器支持
49+
本项目采用以下技术栈:
6950

70-
**本地开发**推荐使用`Chrome 最新版`浏览器,**不支持**`Chrome 80`以下版本。
51+
- [Vue 3](https://v3.vuejs.org/) - 渐进式 JavaScript 框架
52+
- [TypeScript](https://www.typescriptlang.org/) - JavaScript 的超集
53+
- [Vite](https://vitejs.dev/) - 下一代前端构建工具
54+
- [Element-Plus](https://element-plus.org/) - Vue 3 组件库
55+
- [Pinia](https://pinia.vuejs.org/) - Vue 状态管理方案
56+
- [Vue Router](https://router.vuejs.org/) - Vue.js 官方路由
7157

72-
**生产环境**支持现代浏览器,不支持 IE。
58+
## 📸 界面预览
7359

74-
| [![IE](https://raw.githubusercontent.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png)](http://godban.github.io/browsers-support-badges/)IE | [![ Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png)](http://godban.github.io/browsers-support-badges/)Edge | [![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)](http://godban.github.io/browsers-support-badges/)Firefox | [![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)](http://godban.github.io/browsers-support-badges/)Chrome | [![Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png)](http://godban.github.io/browsers-support-badges/)Safari |
75-
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
76-
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
60+
<details>
61+
<summary>点击查看界面预览</summary>
62+
63+
![界面预览](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031408.png)
64+
![设计器](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031335.png)
65+
![组件配置](https://cdn.jsdelivr.net/gh/axelulu/images@master/2024/20241007031638.png)
66+
</details>
67+
68+
## 🌍 浏览器支持
69+
70+
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Safari |
71+
| :---: | :---: | :---: | :---: |
72+
| 最新版本 ✅ | 最新版本 ✅ | 最新版本 ✅ | 最新版本 ✅ |
73+
74+
## 🤝 社区与支持
75+
76+
### 加入交流群
77+
78+
- 微信群:扫描下方二维码
79+
80+
![微信群](https://i.imgur.com/tD8L1B2.png)
81+
82+
- QQ群:[718136001](https://qm.qq.com/q/YPjQJoIxqI)
83+
84+
## 📄 开源协议
85+
86+
[MIT](./LICENSE) License © 2024 [Axelu](https://github.com/ai-lowcode)

0 commit comments

Comments
 (0)