Skip to content
Get packs

Guide · Open source

How to use iview-admin: install, run and build a Vue 2 admin

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

iview-admin is a Vue.js 2.0 admin management template built on the iView component library. It gives you a starting point for back-office sites with login pages, menus, tables and forms. This guide shows you how to get it running locally, build it for production and see which features it includes.

iView Adminiview/iview-admin · ★ 16.3k · MIT

Quick start

  1. 1Check prerequisites. Install Node.js and npm, and make sure git is available.
  2. 2Clone the project. Run git clone https://github.com/iview/iview-admin.git to download the source.
  3. 3Install dependencies. Run npm install inside the project folder.
  4. 4Start the dev server. Run npm run dev and open the local address it reports to view the app.
  5. 5Explore features. Review the login, permission, table and routing examples to see how they are built.
  6. 6Build for production. Run npm run build when you are ready to produce a production build.

What you need before you install iview-admin

The README lists two prerequisites: Node.js and npm. You also need git to clone the project from GitHub.

The template targets Vue 2.0 only, so it is a good fit if your project is on Vue 2 and uses or is willing to use iView components.

  • Node.js
  • npm
  • git

Install iview-admin by cloning and installing dependencies

Clone the repository from GitHub, move into the project folder, then install its dependencies with npm. The README uses the clone-and-build method rather than a package install.

git clone https://github.com/iview/iview-admin.git npm install

Run the development server and build for production

Start the development server with npm run dev to preview the app while you edit it. When you are ready to deploy, run npm run build to produce a production build.

The README's preview of the finished layout is hosted at admin.iviewui.com, which you can compare against your local copy.

npm run dev npm run build

Explore the built-in admin features

The README lists the template's main features. Use them as a reference for how a Vue admin app can be organised.

  • Login and logout, with permission authentication and permission switching
  • i18n for multiple languages
  • Dynamic routing and routes with reference pages
  • Table features: drag-and-drop sort, searchable forms, export to CSV or XLS, and table to picture
  • Components such as a rich text editor, markdown editor, city cascader, file upload, draggable list and split-pane
  • Error pages for 403, 404 and 500
  • Tag navigation, breadcrumbs, sidebar shrink, full screen, lock screen and a message center

Customise the template for your own project

Because iview-admin is a template you run and modify, the usual approach is to keep the layout and features you need and replace the sample pages with your own data and screens.

The README recommends a base template branch for starting new projects. Check the README for the current link before you begin.

What people use it for

  • An internal admin panel for managing users, orders or content
  • A back-office with login, role-based menus and permission checks
  • A data table screen that needs CSV or XLS export
  • A multi-language admin app using the built-in i18n support
  • A reference project for dynamic routing and permissions in Vue 2

Frequently asked questions

Is iview-admin free to use?

Yes. The README states the project is licensed under the MIT License, and the copyright notice is held by TalkingData. Check the LICENSE file in the repository for the full terms.

Does iview-admin work with Vue 3?

The README describes iview-admin as a Vue.js 2.0 template only, so it is not designed for Vue 3. If your project needs Vue 3, look at a different admin template.

What do I need to run iview-admin?

The README lists Node.js and npm as prerequisites. Install them, clone the repository, run npm install, then start with npm run dev.

What are the commands to run iview-admin?

Clone with git clone https://github.com/iview/iview-admin.git, install with npm install, start the development server with npm run dev, and build for production with npm run build.

What are alternatives to iview-admin?

Projects often compared with it include vue-element-admin, vue-admin-template, Ant Design Pro and React Admin. Pick based on your framework and UI library: iview-admin depends on iView components.

Can I export table data with iview-admin?

Yes. The README lists table export to CSV and XLS files as a feature, along with table to picture.

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

iview-admin suits Vue 2 developers who want a working admin layout with login, permissions, routing, i18n and table export to start from. It is less suitable for non-developers, teams on Vue 3, or teams that prefer a UI library other than iView.

Install options & downloads