Skip to content
Get packs

Guide · Open source

How to use go-admin: install, run and sign in

Updated · written with AI from the project's own documentation and checked against our catalogue data

go-admin is an open-source starter kit for building admin systems, the back-office screens used to manage users, menus, roles and settings. It pairs a Go backend built on the Gin framework with a Vue front end that supports Element UI, Arco Design or Ant Design. This guide walks you through getting both parts running locally, signing in, and finding the main configuration and generator features.

go-admingo-admin-team/go-admin · ★ 12.8k · MIT

Quick start

  1. 1Check prerequisites. Install Go, Node.js v22 or newer, pnpm v9 or newer, Git and a C compiler if you plan to use SQLite.
  2. 2Clone both repositories. Place go-admin and go-admin-ui in the same folder using git clone.
  3. 3Build with SQLite support. In the go-admin folder, run go build -tags sqlite3.
  4. 4Run migrations. Run ./go-admin migrate -c config/settings.sqlite.yml to create the database tables.
  5. 5Start the API server. Run ./go-admin server -c config/settings.sqlite.yml. The API is at http://localhost:8000.
  6. 6Start the UI and sign in. In go-admin-ui, run pnpm install then pnpm dev, and sign in with admin / 123456.

What you need before you install go-admin

go-admin is a clone-and-build project. You run a Go backend and a Node front end side by side, so you need both toolchains installed. The README lists the requirements below.

  • Go (the README environment note says go 1.27.1)
  • Node.js v22 or newer (v24 LTS recommended)
  • pnpm v9 or newer, since the UI project uses pnpm
  • Git
  • A C compiler (gcc) if you build with SQLite

Clone the backend and front-end repositories

The two projects must be placed in the same folder. Create a development directory, then clone both repositories into it.

  • Backend: go-admin-team/go-admin
  • Front end: go-admin-team/go-admin-ui
mkdir goadmin cd goadmin git clone https://github.com/go-admin-team/go-admin.git git clone https://github.com/go-admin-team/go-admin-ui.git

Run go-admin quickly with SQLite

SQLite is the shortest route because it needs no separate database server. A plain go build does not include SQLite support, so you must pass the sqlite3 build tag and have a C compiler available (cgo). Run migrations to create the database tables, then start the API server. The API listens at http://localhost:8000.

  • On Windows, use go-admin.exe instead of ./go-admin.
  • If you see a 'cgo' or 'gcc' error on Windows, the C compiler is missing. The README links to an FAQ section on the cgo problem.
cd ./go-admin go build -tags sqlite3 ./go-admin migrate -c config/settings.sqlite.yml ./go-admin server -c config/settings.sqlite.yml

Start the front-end UI and sign in

Open a second terminal in the go-admin-ui folder. If you do not have pnpm, install it with npm first. Install the dependencies, start the dev server, then sign in with the account the README lists for the demo setup: admin / 123456.

  • Sign in with admin / 123456 as shown in the README quick start.
  • The README's online demos are at vue.go-admin.pro and antd.go-admin.pro if you want to see the UI before installing.
npm install -g pnpm pnpm install pnpm dev

Use MySQL, PostgreSQL or SQL Server instead of SQLite

For other databases, skip the SQLite quick start and use the standard config file. Build the backend, then edit the database settings in config/settings.yml. The README notes that the database details live under settings.database. Run migrate and server with that file. Confirm the log path in the same file.

  • Edit the database information under settings.database in config/settings.yml.
  • Check the log path in the same file.
  • Run migrate once to initialise the database, then server to start the service.
  • On Windows, run go-admin.exe with the same arguments.
./go-admin migrate -c config/settings.yml ./go-admin server -c config/settings.yml

Explore the built-in features and code generator

Once the app runs, the built-in modules cover users, departments, positions, menus, roles, dictionaries, parameters, logs and server monitoring. The code generator builds create, read, update and delete pages from a database table structure, through a visual workflow. The form builder lets you lay out pages by dragging components. Swagger API docs are generated from the code, and the project also supports scheduled tasks and multi-tenancy as listed in its feature summary.

  • Role management assigns menu permissions and data scope by organisation.
  • Login log and operation log record sign-ins and system activity.
  • Code generation works from your existing table structure.
  • The README lists unit tests as a TODO, so check coverage yourself before relying on it.

What people use it for

  • A Go developer building an internal back office with login and role permissions already in place.
  • A team that wants a Vue admin front end using Element UI, Arco Design or Ant Design.
  • A student studying how a Gin, GORM and Vue admin system is structured.
  • Scaffolding basic create, read, update and delete pages from database tables with the code generator.

Frequently asked questions

Is go-admin free to use?

go-admin is released under the MIT licence, according to the project's repository details. You can use, modify and distribute it under that licence. Check the LICENSE file in the repository for the full terms.

What do I need to install go-admin?

You need Go, Node.js v22 or newer (v24 LTS recommended), pnpm v9 or newer, Git, and a C compiler such as gcc if you build with SQLite. The backend and front-end repositories must sit in the same folder.

Why does go build fail with a cgo or gcc error on Windows?

The SQLite driver uses cgo, which needs a C compiler. The README shows the 'executable file not found' and 'missing-cc' errors when none is installed. Install a C compiler, then rebuild; the README links to its cgo FAQ for details.

Can I use go-admin without writing code?

Not fully. go-admin requires running a Go backend and a Node front end, and the code generator and form builder reduce coding but do not remove setup. The project is aimed at developers and teams, not people who want a finished app with no setup.

Which UI library does go-admin support?

The front end supports Element UI, Arco Design and Ant Design. The README also links a Vue 3 Element Plus demo and an antd demo.

How does go-admin compare with gin-vue-admin?

Both are Go and Vue admin starters. go-admin is built on Gin with GORM, Casbin RBAC and JWT login, and offers Element UI, Arco Design or Ant Design front ends. Compare the two repositories on the features you need, such as the UI library and code generator, before choosing.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

go-admin suits Go developers, small teams and students who want a working Gin and Vue admin backend with login, permissions and a code generator, and who are comfortable with a two-part setup. Pick something else if you want a no-code tool, a finished app with no setup, or a project with proven test coverage, since unit tests are still a TODO in the README.

Install options & downloads