go-admin README

The project's README from github.com/go-admin-team/go-admin. As one markdown file: README.md.

go-admin

Build Status Release License

English | 简体中文 | 繁體中文 | 日本語

The front-end and back-end separation authority management system based on Gin + Vue + Element UI OR Arco Design OR Ant Design is extremely simple to initialize the system. You only need to modify the database connection in the configuration file. The system supports multi-instruction operations. Migration instructions can make it easier to initialize database information. Service instructions It's easy to start the api service.

documentation

Front-end project

Video tutorial

🎬 Online Demo

Element Plus vue3 demo:https://vue.go-admin.pro

Account / Password: admin / 123456

antd demo (go-admin-pro):https://antd.go-admin.pro

Account / Password: admin / 123456

✨ Feature

🎁 Internal

  1. User management: The user is the system operator, this function mainly completes the system user configuration.
  2. Department management: configure the system organization (company, department, group), and display the tree structure to support data permissions.
  3. Position management: configure the positions of system users.
  4. Menu management: configure the system menu, operation authority, button authority identification, interface authority, etc.
  5. Role management: Role menu permission assignment and role setting are divided into data scope permissions by organization.
  6. Dictionary management: Maintain some relatively fixed data frequently used in the system.
  7. Parameter management: dynamically configure common parameters for the system.
  8. Operation log: system normal operation log record and query; system abnormal information log record and query.
  9. Login log: The system login log record query contains login exceptions.
  10. Interface documentation: Automatically generate related api interface documents according to the business code.
  11. Code generation: According to the data table structure, generate the corresponding addition, deletion, modification, and check corresponding business, and the whole process of visual operation, so that the basic business can be implemented with zero code.
  12. Form construction: Customize the page style, drag and drop to realize the page layout.
  13. Service monitoring: View the basic information of some servers.
  14. Content management: demo function, including classification management and content management. You can refer to the easy to use quick start.

Ready to work

You need to install locally [go] [gin] node 和 git

At the same time, a series of tutorials including videos and documents are provided. How to complete the downloading to the proficient use, it is strongly recommended that you read these tutorials before you practice this project! ! !

Easily implement go-admin to write the first application-documentation tutorial

Step 1 - basic content introduction

Step 2 - Practical application - writing database operations

Teach you from getting started to giving up-video tutorial

How to start go-admin

Easily implement business using build tools

v1.1.0 version code generation tool-free your hands [Advanced]

Explanation of multi-command startup mode and IDE configuration

Configuration instructions for go-admin menu [Must see]

How to configure menu information and interface information [Must see]

go-admin permission configuration instructions [Must see]

Instructions for use of go-admin data permissions [Must see]

If you have any questions, please read the above-mentioned usage documents and articles first. If you are not satisfied, welcome to issue and pr. Video tutorials and documents are being updated continuously.

📦 Local development

Environmental requirements

go 1.26.5

nodejs: v22+ (v24 LTS recommended)

package manager: pnpm v9+ (the UI project uses pnpm)

Development directory creation


# Create a development directory
mkdir goadmin
cd goadmin

Get the code

Important note: the two projects must be placed in the same folder;

# Get backend code
git clone https://github.com/go-admin-team/go-admin.git

# Get the front-end code
git clone https://github.com/go-admin-team/go-admin-ui.git

Startup instructions

Server startup instructions

# Enter the go-admin backend project
cd ./go-admin

# Update dependencies
go mod tidy

# Compile the project
go build

# Change setting 
# File path go-admin/config/settings.yml
vi ./config/settings.yml

# 1. Modify the database information in the configuration file
# Note: The corresponding configuration data under settings.database
# 2. Confirm the log path

⚠️ Note that this problem will occur if CGO is not installed in the windows10+ environment;

E:\go-admin>go build
# github.com/mattn/go-sqlite3
cgo: exec /missing-cc: exec: "/missing-cc": file does not exist

or

D:\Code\go-admin>go build
# github.com/mattn/go-sqlite3
cgo: exec gcc: exec: "gcc": executable file not found in %PATH%

Solve the cgo problem and enter

Initialize the database, and start the service

# The first configuration needs to initialize the database resource information
# Use under macOS or linux
$ ./go-admin migrate -c config/settings.dev.yml

# ⚠️Note: Use under windows
$ go-admin.exe migrate -c config/settings.dev.yml

# Start the project, you can also use the IDE for debugging
# Use under macOS or linux
$ ./go-admin server -c config/settings.yml

# ⚠️Note: Use under windows
$ go-admin.exe server -c config/settings.yml

Use docker to compile and start

# Compile the image
docker build -t go-admin .


# Start the container, the first go-admin is the container name, and the second go-admin is the image name
# -v Mapping configuration file Local path: container path
docker run --name go-admin -p 8000:8000 -v /config/settings.yml:/config/settings.yml -d go-admin-server

Generation Document

go generate

Cross compile

# windows
env GOOS=windows GOARCH=amd64 go build main.go

# or
# linux
env GOOS=linux GOARCH=amd64 go build main.go

UI interactive terminal startup instructions

# Install pnpm if you don't have it
npm install -g pnpm

# Installation dependencies
pnpm install

# Start service
pnpm dev

📨 Interactive

wenjianzhang
Wechat Wechat公众号🔥🔥🔥 go-admin技术交流乙号 bilibili🔥🔥🔥

💎 Contributors

JetBrains open source certificate support

The go-admin project has always been developed in the GoLand integrated development environment under JetBrains, based on the free JetBrains Open Source license(s) genuine free license. I would like to express my gratitude.

🤝 Thanks

  1. ant-design
  2. ant-design-pro
  3. arco-design
  4. arco-design-pro
  5. gin
  6. casbin
  7. spf13/viper
  8. gorm
  9. gin-swagger
  10. golang-jwt
  11. vue-element-admin
  12. ruoyi-vue
  13. form-generator

🤟 Sponsor Us

If you think this project helped you, you can buy a glass of juice for the author to show encouragement :tropical_drink:

🔑 License

MIT

Copyright (c) 2026 wenjianzhang

go-admin (go-admin-team/go-admin)

Searching Database…

12.8K ·GitHub
这是什么?go-admin 是一个全栈脚手架,用来搭建后台管理系统:后端是基于 Gin 的 Go REST API,前端是 Vue,可选 Element UI、Arco Design 或 Ant Design。它自带 RBAC 权限控制、多租户支持、JWT 认证、代码生成器和拖拽式表单生成器,可以帮你快速搭起一个管理后台。
我拿到的是一个应用,还是需要分别运行 Go 后端和 Vue 前端?它们是两个独立的项目(一个 Go 服务端和一个 Vue 界面),需要并排克隆、分别运行;README 明确说明这两个项目必须放在同一个文件夹中。
我该怎样在本地运行它?把服务端和 UI 仓库克隆到同一个文件夹,初始化数据库并启动 Go 服务,然后在另一个终端单独启动 Vue UI 的开发服务。项目也提供了基于 Docker 的编译并启动方式。
开始之前需要安装哪些东西?本地需要 Go、Gin、Node.js 和 git;文档中注明的版本是 Go 1.26.5、Node v22+(推荐 v24 LTS),以及 UI 项目使用的 pnpm v9+ 包管理器。
安装时有哪些已知的坑?在 Windows 10+ 上,如果没有先正确设置 CGO,会遇到与 CGO 相关的编译错误;README 明确把这一点列为已知问题。
它能在哪些平台上运行?Go 服务端可以在 Linux、Windows 和 macOS 上运行,也可以用 Docker 打包成容器;Vue UI 是一个基于浏览器的网页应用。
开箱即用的功能有哪些?用户、部门、岗位、菜单、角色和字典管理,操作日志和登录日志,参数配置,API 文档,代码生成器,拖拽式表单生成器,以及基础的服务器监控。
权限控制是怎样实现的?基于角色的访问控制(RBAC)建立在 Casbin 之上,使用 JWT 进行身份认证,并可以按角色分配菜单、按钮和接口级别的权限。
为什么有三种不同的界面主题(Element、Arco、Ant Design)?go-admin 分别基于 Ant Design Pro、Arco Design Pro 和 Element UI 提供了不同的前端版本,你可以根据项目选择合适的设计体系;README 中还附有在线的 Antd PRO 演示链接。
支持多租户吗?支持。多租户是其核心功能之一,与 RBAC 资源控制和表单生成器并列。
Size
18.6 MB
Stars
12.8K
Age
6y
Commits · 90 Days