go-admin Authority Management System

go-admin is a decoupled (frontend/backend) permission management system built with Gin (backend) and Vue/Element UI/Arco Design/Ant Design (frontend).

Key features include:

• RESTful API design.
• RBAC access control using Casbin.
• JWT authentication.
• Swagger documentation (via swaggo).
• GORM based database storage (supports multiple database types).
• Multi-tenancy support (database-per-tenant model).
• Code Generation and Form Building tools for rapid development.
• Multi-command CLI interface for migrations and server management.

go-admin is a front-end and back-end separated authority management system. It uses Gin for the backend API and Vue with either Element UI or Arco Design for the frontend.

Key features include:

• RESTful API design.
• RBAC access control via Casbin.
• JWT authentication.
• Swagger documentation (via swaggo).
• GORM based database storage (supports multiple database types).
• Code generation and Form builder tools to accelerate development.
• Multi-command mode for service management (e.g., migration, server startup).

Create a development directory and clone both the backend and frontend repositories into it:

# Create a development directory
mkdir goadmin
cd goadmin

# 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

To run the frontend development server, use pnpm:

1. Install pnpm (if not already installed):

   npm install -g pnpm

2. Install dependencies and run:

   pnpm install
   pnpm dev

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

# Installation dependencies
pnpm install

# Start service
pnpm dev

You can compile and run the backend using Docker.

1. Build the image:

   docker build -t go-admin .

2. Run the container: Map the local configuration file to the container and expose port 8000.

   docker run --name go-admin -p 8000:8000 -v /config/settings.yml:/config/settings.yml -d go-admin-server

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

# Start the container
docker run --name go-admin -p 8000:8000 -v /config/settings.yml:/config/settings.yml -d go-admin-server

You can build a Docker image and run the service using the following commands:

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

# Run the container
# Maps port 8000 and mounts the local config file
docker run --name go-admin -p 8000:8000 -v /config/settings.yml:/config/settings.yml -d go-admin-server

# Build image
docker build -t go-admin .

# Run container
docker run --name go-admin -p 8000:8000 -v /config/settings.yml:/config/settings.yml -d go-admin-server

To compile the Go backend for different operating systems, use the GOOS and GOARCH environment variables:

For Windows:

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

For Linux:

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

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

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

The backend uses a multi-command mode. You must first migrate the database before starting the server.

1. Database Migration

Run the migration command to initialize database resource information.

macOS/Linux:

./go-admin migrate -c config/settings.dev.yml

Windows:

go-admin.exe migrate -c config/settings.dev.yml

2. Start the Server

Once migrated, start the API service.

macOS/Linux:

./go-admin server -c config/settings.yml

Windows:

go-admin.exe server -c config/settings.yml

# Use under macOS or linux
$ ./go-admin migrate -c config/settings.dev.yml

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

# Start the project (macOS/Linux)
$ ./go-admin server -c config/settings.yml

# Start the project (Windows)
$ go-admin.exe server -c config/settings.yml

Navigate to the go-admin-ui directory and use pnpm to start the development server:

cd go-admin-ui

# Install dependencies (use mirror if in China)
pnpm install --registry=https://registry.npmmirror.com

# Start development server
pnpm dev

Follow these steps to compile and configure the backend service:

1. Update dependencies and build:

   cd ./go-admin
   go mod tidy
   go build

2. Configure database and logs: Edit the configuration file located at go-admin/config/settings.yml.

   • Update the settings.database section with your database credentials.
   • Verify the log file paths.

Note for Windows users: If you encounter cgo errors (e.g., exec: "gcc": executable file not found), you must install a C compiler (like MinGW) to support go-sqlite3.

# 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

Create a development directory and clone both the backend and frontend repositories into it:

# Create development directory
mkdir goadmin
cd goadmin

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

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