mirror of
https://github.com/bufanyun/hotgo.git
synced 2025-10-21 17:33:47 +08:00
发布v2.2.10版本,更新内容请查看:https://github.com/bufanyun/hotgo/tree/v2.0/docs/guide-zh-CN/addon-version-upgrade.md
This commit is contained in:
108
README.md
108
README.md
@@ -28,20 +28,21 @@
|
||||
|
||||
|
||||
## 平台简介
|
||||
* 基于全新Go Frame 2+Vue3+Naive UI开发的全栈前后端分离的管理系统
|
||||
* 前端采用naive-ui-admin 、Vue、Naive UI。
|
||||
* 基于全新Go Frame 2+Vue3+Naive UI+UinApp开发的全栖框架,为二次开发而生,适合中小型完整应用开发。
|
||||
* 前端采用naive-ui-admin 、Vue、Naive UI、UinApp。
|
||||
|
||||
|
||||
## 特征
|
||||
* 高生产率:几分钟即可搭建一个后台管理系统
|
||||
* 模块化:单应用多系统的模式,将一个完整的应用拆分为多个系统,后续扩展更加便捷,增加代码复用性。
|
||||
* 插件化: 可通过插件的方式扩展系统功能
|
||||
* 认证机制:采用jwt的用户状态认证及casbin的权限认证
|
||||
* 路由模式:得利于goframe2.0提供了规范化的路由注册方式,无需注解自动生成api文档
|
||||
* 面向接口开发
|
||||
* 高生产率:极强的可扩展性,应用化、模块化、插件化机制敏捷开发,几分钟即可搭建一个应用开发骨架。
|
||||
* 多应用入口:多入口分为 Admin (后台)、Home (前台页面)、Api (对外通用接口)、Websocket (即时通讯接口),不同的业务,进入不同的应用入口。
|
||||
* 极致的插件化: 微核架构,功能隔离,高可定制性,可以渐进式开发,亦可以多人协同开发。支持一键创建插件模板、一键安装、更新、卸载插件、可以非常方便的将插件迁移到新项目中。
|
||||
* 快速生成代码:无需编写代码,只需创建表进行简单配置就能生成一个完善的 CURD、树表等常用的开发代码,其中所需表单控件也是勾选即可直接生成。
|
||||
* 认证机制:采用 JWT 的用户状态认证及 casbin 的权限认证
|
||||
* 路由模式:得益于 goframe2.0 提供了规范化的路由注册方式,无需注解自动生成api文档
|
||||
* 模块化设计,面向接口开发
|
||||
|
||||
|
||||
## 内置功能
|
||||
## 后台内置功能
|
||||
|
||||
1. 用户管理:用户是系统操作者,该功能主要完成系统用户配置。
|
||||
2. 部门管理:配置系统组织机构(公司、部门、岗位),树结构展现支持数据权限。
|
||||
@@ -56,12 +57,13 @@
|
||||
11. 在线用户:当前系统中活跃用户状态监控。
|
||||
12. 定时任务:在线(添加、修改、删除)任务调度包含执行结果日志。
|
||||
13. 代码生成:支持自动化生成前后端代码。CURD关联表、树表、消息队列、定时任务一键生成等。
|
||||
14. 服务监控:监视当前系统CPU、内存、磁盘、网络、堆栈等相关信息。
|
||||
15. 附件管理:文件上传,多种上传方式适配。
|
||||
16. 消息队列:同时兼容 kafka、redis、rocketmq、磁盘队列,一键配置切换到场景适用的MQ。
|
||||
17. 通知公告:采用websocket实时推送在线用户最新通知、公告、私信消息。
|
||||
18. 地区编码:整合国内通用省市区编码,运用于项目于一身,支持动态省市区选项。
|
||||
19. 常用工具:集成常用的工具包和命令行工具,可以快速开发自定义命令行,多种启动入口。
|
||||
14. 插件应用:支持一键生成插件模板,每个插件之间开发隔离,拥有独立多应用入口、独立配置。完美支持多人协同开发、插件插拔不会对原系统产生影响等。
|
||||
15. 服务监控:监视当前系统CPU、内存、磁盘、网络、堆栈等相关信息。
|
||||
16. 附件管理:文件上传,多种上传方式适配。
|
||||
17. 消息队列:同时兼容 kafka、redis、rocketmq、磁盘队列,一键配置切换到场景适用的MQ。
|
||||
18. 通知公告:采用websocket实时推送在线用户最新通知、公告、私信消息。
|
||||
19. 地区编码:整合国内通用省市区编码,运用于项目于一身,支持动态省市区选项。
|
||||
20. 常用工具:集成常用的工具包和命令行工具,可以快速开发自定义命令行,多种启动入口。
|
||||
|
||||
|
||||
> HotGo开源以来得到了大家的很多支持,本项目初衷只为互相学习交流,没有任何盈利性目的!欢迎为HotGo贡献代码或提供建议!
|
||||
@@ -70,81 +72,9 @@
|
||||
- [https://hotgo.facms.cn/admin](https://hotgo.facms.cn/admin)
|
||||
> 账号:admin 密码:123456
|
||||
|
||||
### 使用文档
|
||||
|
||||
## 环境要求
|
||||
- node版本 >= v16.0.0
|
||||
- golang版本 >= v1.18
|
||||
- gf版本 >=v2.3.1 (会保持同步gf最新版本,gf小版本更新可能存在兼容问题,旧版本需自行处理,如非必要不建议更新!)
|
||||
- IDE推荐:Goland
|
||||
- mysql版本 >=5.7
|
||||
- redis版本 >=3.0
|
||||
|
||||
## 快速开始
|
||||
一、拉取代码到你已经安装好以上环境的服务器中
|
||||
```shell script
|
||||
git clone https://github.com/bufanyun/hotgo.git && cd hotgo
|
||||
```
|
||||
|
||||
二、配置你的站点信息
|
||||
|
||||
服务端:
|
||||
- 项目数据库文件 `resource/data/db.sql` 创建数据库并导入
|
||||
- 修改配置 `manifest/config/config.yaml.bak` 复制改为`manifest/config/config.yaml`
|
||||
|
||||
|
||||
后台前端:
|
||||
- 配置服务端地址,包含在以下文件中:
|
||||
* /hotgo/web/.env.development
|
||||
* /hotgo/web/.env.production
|
||||
* /hotgo/web/.env
|
||||
|
||||
其中必改配置
|
||||
```
|
||||
VITE_PROXY=[["/admin","http://你的IP:8000/admin"]]
|
||||
```
|
||||
|
||||
三、 启动服务
|
||||
服务端:
|
||||
```shell script
|
||||
cd server
|
||||
|
||||
# 设置国内代理,如果已经设置好了代理可以跳过
|
||||
go env -w GOPROXY=https://goproxy.io,direct
|
||||
|
||||
# 更新包
|
||||
go mod tidy
|
||||
|
||||
# 查看命令行方法
|
||||
go run main.go hlep
|
||||
|
||||
# 启动所有服务
|
||||
go run main.go # 热编译启动: gf run main.go
|
||||
|
||||
# 如果顺利,至此到浏览器打开:http://你的IP:8000/admin,即可看到后台登录地址
|
||||
# 登录账号:admin, 密码:123456
|
||||
# 好奇为什么没有运行前端代码就能将后台运行起来?这要得益于gf强大的pack功能!
|
||||
# 当然这只是为了降低运行门槛,如果想对前端进行开发请继续往下看
|
||||
|
||||
```
|
||||
|
||||
web端:
|
||||
```shell script
|
||||
cd web
|
||||
# 首先确定你以安装node16.0以上版本并安装了包[npm、yarn],否则可能会出现一些未知报错
|
||||
|
||||
# 安装依赖
|
||||
yarn install
|
||||
|
||||
# 启动web项目
|
||||
yarn dev
|
||||
|
||||
# 如果顺利,至此到浏览器打开:http://你的IP:8001/admin
|
||||
```
|
||||
|
||||
|
||||
## 文档地址
|
||||
> 文档正在书写中,请耐心等一等。
|
||||
|
||||
[安装文档](docs/guide-zh-CN/start-installation.md) · [本地文档](docs/guide-zh-CN/README.md) · [更新历史](docs/guide-zh-CN/start-update-log.md) · [常见问题](docs/guide-zh-CN/start-issue.md)
|
||||
|
||||
## 演示图
|
||||
|
||||
|
Reference in New Issue
Block a user