Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
zds-s committed Oct 11, 2024
2 parents dbbd7c5 + f0052df commit a0815a0
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 1 deletion.
39 changes: 38 additions & 1 deletion docs/zh/front/base/concept.md
Original file line number Diff line number Diff line change
@@ -1 +1,38 @@
# 基础概念
# 基础概念

最新的 `3.0` 版本,整个项目进行了重构,现在我们将会介绍一些基础概念,以便于你更好的理解整个文档,请务必仔先阅读这一部分。

::: tip
以下所讲全部针对源码根目录下的 `./web` 里的结构
:::

## 全局类型

由于新版采用 `Typescript` 所写,全局的类型定义都在 `./types` 目录下存放着,可在里面找到相关的数据类型结构。

## 模块

新版本进行模块化划分,目录为 `./src/modules`。目录下可以存在不同的模块,每个模块管理着的所属业务的 `api``types``ts`以及`视图文件`

## 插件

新版前端中新增了一个 `./src/plugins` 目录,专门存放独立应用或者插件等等。

## 别名系统
`vite.config.ts` 文件中定义了以下别名,在引入文件时可使用别名代替全量路径:

```json vite.config.ts
"resolve": {
"alias": {
'@': path.resolve(__dirname, 'src'),
'#': path.resolve(__dirname, 'types'),
'$': path.resolve(__dirname, 'src/plugins'),
'~': path.resolve(__dirname, 'src/modules'),
},
},
```

- `@`:代表了 `./src` 目录,一般情况下所有前端项目默认都有此别名。
- `#`:代表了 `./types` 目录,可方便引入全局类型。
- `$`: 代表了 `./src/plugins` 目录,可方便快速的引入插件内的文件。
- `~`: 代表了 `./src/modules` 目录,可方便快速的引入模块内的文件。
30 changes: 30 additions & 0 deletions docs/zh/front/base/start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 开始

::: tip 提示
以下内容全以源码已经下载好,并在命令行下进入到了 `./web` 目录为前提。
:::

## 开发环境

需要在本地依次安装好 [Node.js](https://nodejs.org/zh-cn), [pnpm](https://pnpm.io/zh/)。也可以使用 `yarn` 等其他包管理工具,推荐使用 `pnpm`,文档内容以 `pnpm` 为准。

- Node.js >= 20.0.0,推荐 20.x.x 的 LTS 版本
- PNPM >= 9.0.0

## 安装依赖及运行
运行成功后,会自动打开页面,默认地址为 http://localhost:2888

```bash
# 安装依赖
pnpm i 或 pnpm install

# 运行
pnpm dev
```

::: warning 安装依赖报错
如果无法正常安装依赖,可能是因为 npm 默认源无法访问,
可以尝试执行 `pnpm config set registry https://registry.npmmirror.com/`
切换为国内 `npmmirror` 镜像源(也可以使用 [nrm](https://github.com/Pana/nrm) 一键切换源),
然后删除根目录下 `/node_modules` 文件夹并重新安装依赖。
:::
17 changes: 17 additions & 0 deletions docs/zh/guide/introduce/mineadmin.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,20 @@
- 无论是个人开发者的轻量级应用初创项目的快速搭建,还是企业级应用的复杂需求,我们的系统都能提供强有力的支持,助您实现快速开发、快速落地、快速迭代及快速部署。
:::

## 内置功能
- 用户管理,完成用户添加、修改、删除配置。
- 角色管理,角色菜单权限分配、角色数据权限分配(基于casbin)。
- 菜单管理,配置系统菜单、前端路由和按钮等权限。
- 操作日志,用户对系统的一些正常操作的查询。
- 登录日志,用户登录系统的记录查询
- 代码生成,根据数据库表结构生成对应的增删改查(前后端)代码,目前待完成。
- 应用市场,MineAdmin的生态系统,提供丰富的插件和模板,方便用户快速搭建自己的应用。
- 用户中心,专门的布局和页面,独立的菜单,提供用户资料修改等操作,可扩展其他功能。

## 发展历程

从 MineAdmin 0.x 版本开始,后台系统经历了许多迭代和优化。

后端使用的 Hyperf 框架从 2.0 跟随升级到 3.0。前端从最早一开始使用的 SCUI 开源前端项目,到后来基于 Arco 自行开发了一套前端框架,
再到现在采用全新的架构,重构了前后端代码,精简了功能。新版本中,重新开始,不断优化框架,以提供更好的用户体验。
我们的目标是让开发者能够快速上手,专注于业务逻辑的开发,并为企业和品牌创造价值。

0 comments on commit a0815a0

Please sign in to comment.