vue-admin-template README

The project's README from github.com/PanJiaChen/vue-admin-template. As one markdown file: README.md.

vue-admin-template

English | 简体中文

A minimal vue admin template with Element UI & axios & iconfont & permission control & lint

Live demo: http://panjiachen.github.io/vue-admin-template

The current version is v4.0+ build on vue-cli. If you want to use the old version , you can switch branch to tag/3.11.0, it does not rely on vue-cli

SPONSORED BY

Build Setup

# clone the project
git clone https://github.com/PanJiaChen/vue-admin-template.git

# enter the project directory
cd vue-admin-template

# install dependency
npm install

# develop
npm run dev

This will automatically open http://localhost:9528

Build

# build for test environment
npm run build:stage

# build for production environment
npm run build:prod

Advanced

# preview the release environment effect
npm run preview

# preview the release environment effect + static resource analysis
npm run preview -- --report

# code format check
npm run lint

# code format check and auto fix
npm run lint -- --fix

Refer to Documentation for more information

Demo

demo

Extra

If you want router permission && generate menu by user roles , you can use this branch permission-control

For typescript version, you can use vue-typescript-admin-template (Credits: @Armour)

Browsers support

Modern browsers and Internet Explorer 10+.

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
IE10, IE11, Edge last 2 versions last 2 versions last 2 versions

License

MIT license.

Copyright (c) 2017-present PanJiaChen

vue-admin-template (PanJiaChen/vue-admin-template)

vue-cli
Searching Database…

What is this?A minimal admin dashboard template for Vue 2 by PanJiaChen: a ready frontend skeleton with Element UI components, axios, iconfont icons, permission control and lint, meant as a starting point for your own admin panel.
Is it a finished product or something I build my own app on?It's a boilerplate: you clone it and build your own admin panel on top of its ready-made layout, vue-router routing, Vuex state management and axios HTTP layer.
How do I get it running?Clone the repo, run npm install, then npm run dev — the vue-cli dev server starts and opens the page in your browser. For production use npm run build:prod.
What do I need to have installed first?Node.js 8.9+ and npm 3.0+. Vue, Element UI, vue-router, Vuex and axios all come as npm dependencies, and there's no backend to deploy — it's a pure frontend talking to your API.
Does role-based menu and router permission work out of the box?Basic permission control is included, but for router permissions and menus generated from user roles the README points you to a separate permission-control branch; vue-element-admin is the full-featured sibling project.
Can I use it in commercial projects?Yes — it's MIT licensed (PanJiaChen, 2017-present), so commercial use, modification and distribution are all fine.
Which browsers does it support?Modern browsers plus Internet Explorer 10/11 and Edge — the README's compatibility table promises IE10+ and the last two versions of Firefox, Chrome and Safari.
What is preconfigured out of the box?Element UI components, axios for HTTP, iconfont icons, normalize.css, the nprogress loading bar, js-cookie, ESLint, Jest unit tests, svgo-based SVG icon handling, plus separate staging and production build modes.
How does it differ from vue-element-admin?Same author, different weight: vue-element-admin is the full-featured admin demo, while this repo is its minimal starting skeleton. The family also includes electron-vue-admin and the TypeScript port vue-typescript-admin-template.
Is the older version without vue-cli still available?Yes — the current v4.0+ line is built on vue-cli, and the pre-vue-cli version lives on the tag/3.11.0 branch.
Creator
PanJiaChen
Size
1 MB
Stars
20.4K
Age
9y
Commits · 90 Days