# vue3-toimc-admin-doc

**Repository Path**: toimc-team/vue3-toimc-admin-doc

## Basic Information

- **Project Name**: vue3-toimc-admin-doc
- **Description**: vue3-toimc-admin项目文档站
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2022-04-25
- **Last Updated**: 2025-01-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

中文 | [English](./README.md)

<div align="center"> <a href="https://github.com/toimc-team/vue3-toimc-admin"> <img alt="Toimc Logo" width="360" height="100" src="https://toimc-online.obs.cn-east-3.myhuaweicloud.com/logo.png"> </a> <br> <br>
</div>

> 此文档站基于 `vuepress-next` 构建

Hello，小伙伴们，我们是 toimc 开源项目团队，本站将详细描述 toimc-admin 的相关使用姿势，帮助大家来了解 toimc-admin，了解我们团队。

## 项目地址

### Admin

admin gitee 镜像站：[https://gitee.com/toimc-team/vue3-toimc-admin](https://gitee.com/toimc-team/vue3-toimc-admin)<br/>
admin github 镜像站：[https://github.com/toimc-team/vue3-toimc-admin](https://github.com/toimc-team/vue3-toimc-admin)

### Docs

docs gitee 镜像站：[https://gitee.com/toimc-team/vue3-toimc-admin-doc](https://gitee.com/toimc-team/vue3-toimc-admin-doc)<br/>
docs github 镜像站：[https://github.com/toimc-team/vue3-toimc-admin-doc](https://github.com/toimc-team/vue3-toimc-admin-doc)

## 起源

2022 年 2 月 7 日，Vue 3 成为了新的默认版本。

市面上也出现了很多基于 Vue 3 开发的优秀的中后台解决方案，如 NaiveAdmin、vue-vben-admin、vue-admin-better 等，但是在这些解决方案相关的生态、跨端方案、安全方案等有所欠缺，于是我们便想打造一款拥有良好生态的企业级跨端前后台解决方案。

## 项目开发

版本要求：

- Node LTS 14+
- pnpm 6.x+/yarn/npm

安装依赖：

```sh
# 推荐
$ pnpm install

# 或者
$ yarn install

# 或者
$ npm install
```

运行项目：

```sh
$ pnpm run dev
```

打包：

```sh
$ pnpm run build
```

## 背景及说明

### 产品优势

- 开源版本免费商用
- 采用最新的技术栈 vue3+typescript+vite
- 完整的社区生态
- 基于 RBAC 及 JWT 鉴权机制
- 企业级前端安全解决方案
- 多主题、多种布局灵活切换
- 快速迭代

### 进展

当前阶段它包含登录、布局、菜单路由以及常用基础组件：

同时，也在建设我们开源项目的文档站，希望能打造一个优秀的项目文档，能让使用我们开源项目的同学们，开箱即用。

整个开源团队已组成，包含产品、开发、运营共 8 人的小伙伴，每天小伙伴们都在愉快的讨论技术。

计划进展：[Github issues label: Plan](https://github.com/toimc-team/vue3-toimc-admin/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aplan)

### 未来规划

在当前阶段完成后，我们还将继续丰富我们的基础组件，增加高可用的业务组件，单元测试方案以及前端安全解决方案。我们还将围绕开源项目开展运营，以推广我们的开源项目，同时围绕开源项目建设技术社区、知识付费、积分体系等，来为参与我们开源项目，使用我们开源项目的小伙伴提供技术交流分享、内容变现的平台。

## 如何加入

人才需求：

- 前端：Vue,React,Nodejs
- 后端：java,go,python,C++/C
- 测试
- 运营：文案、抖音、社群

## 如何贡献

- 加入微信群
- 了解对标项目
  - Vben: https://vvbin.cn/next/#/dashboard/analysis
  - Vue-admin: https://vue-admin-beautiful.com/admin-plus/
  - arco: https://react-pro.arco.design/dashboard/monitor
  - Naive: https://naive-ui-admin.vercel.app/#/dashboard/console
- 看看 issues 中是否有计划与讨论：
  - 计划：[enhancement](https://github.com/toimc-team/vue3-toimc-admin/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
  - 讨论：[discussion](https://github.com/toimc-team/vue3-toimc-admin/issues?q=is%3Aissue+is%3Aopen+label%3Adiscussion)
- （非必须）自己创建 issues，并加入计划
- 下载项目，coding，测试~~
- PR：[在这里](https://github.com/toimc-team/vue3-toimc-admin/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc)

- 等待审核，合并~~

## 项目赞助

如果你认为这个项目对你有帮助，你可以帮作者买一杯咖啡，以示支持!

<img src="https://toimc-online.obs.cn-east-3.myhuaweicloud.com/vue-toimc-admin/payme.jpg" alt="payme" style="zoom:30%;" />

Paypal：[https://paypal.me/toimc](https://paypal.me/toimc)


## 协议

Vue-toimc-admin-doc 是 [MIT](./LICENSE) 协议的开源项目。