English | ็ฎไฝไธญๆ
Overview
vue-typescript-admin-template is a production-ready front-end solution for admin interfaces based on vue, typescript and UI Toolkit element-ui. The original Javascript version code vue-element-admin was written by PanJiaChen, many thanks to him for the awesome open source project! :)
If you want to get started with a minimal template code instead of integration solution, you can take a look at the minimal branch.
Documentation
Live demo
Screenshots
Related Projects
Armour/vue-typescript-admin-mock-server (mock server for this project)
Armour/vue-typescript-admin-docs (documentation source for this project)
Javascript version:
PanJiaChen/vue-admin-template (a vue2.0 minimal admin template)
PanJiaChen/vue-element-admin (full features supported vue admin)
PanJiaChen/electron-vue-admin (a vue electron admin project)
Features
- Login / Logout
- Permission Authentication
- Page permission
- Directive permission
- Permission configuration page
- Two-step login
- Multi-environment build
- Dev / Stage / Prod
- Global Features
- I18n
- Dynamic themes
- Dynamic sidebar (supports multi-level routing)
- Dynamic breadcrumb
- Tags-view (supports right-click operation)
- Clipboard
- Svg icons
- Search
- Screenfull
- Settings
- Mock data / Mock server
- PWA support
- Components
- Editors
- Rich Text Editor
- Markdown Editor
- JSON Editor
- Avatar Upload
- Back To Top
- CountTo
- Dropzone
- Draggable Dialog
- Draggable Kanban
- Draggable List
- Draggable Select
- ECharts
- Mixin
- SplitPane
- Sticky
- Table
- Dynamic Table
- Draggable Table
- Inline Edit Table
- Complex Table
- Excel
- Export Excel
- Upload Excel
- Excel Visualization
- Zip
- Export zip
- PDF
- Download pdf
- Dashboard
- Guide Page
- Advanced Example Page
- Error Log
- Error Page
- 401
- 404
Preparation
You need to install node and git locally. The project is based on typescript, vue, vuex, vue-router, vue-cli , axios and element-ui, all request data is simulated using faker.js. Understanding and learning these knowledge in advance will greatly help you on using this project.
Project Structure
โโโ mock/ # mock server & mock data
โโโ public # public static assets (directly copied)
โ โโโ favicon.ico # favicon
โ โโโ manifest.json # PWA config file
โ โโโ index.html # index.html template
โโโ src # main source code
โ โโโ api # api service
โ โโโ assets # module assets like fonts, images (processed by webpack)
โ โโโ components # global components
โ โโโ directives # global directives
โ โโโ filters # global filter
โ โโโ icons # svg icons
โ โโโ lang # i18n language
โ โโโ layout # global layout
โ โโโ pwa # PWA service worker related files
โ โโโ router # router
โ โโโ store # store
โ โโโ styles # global css
โ โโโ utils # global utils
โ โโโ views # views
โ โโโ App.vue # main app component
โ โโโ main.ts # app entry file
โ โโโ permission.ts # permission authentication
โ โโโ settings.ts # setting file
โ โโโ shims.d.ts # type definition shims
โโโ tests/ # tests
โโโ .circleci/ # automated CI configuration
โโโ .browserslistrc # browserslist config file (to support Autoprefixer)
โโโ .editorconfig # editor code format consistency config
โโโ .env.xxx # env variable configuration
โโโ .eslintrc.js # eslint config
โโโ babel.config.js # babel config
โโโ jest.config.js # jest unit test config
โโโ package.json # package.json
โโโ postcss.config.js # postcss config
โโโ tsconfig.json # typescript config
โโโ vue.config.js # vue-cli configProject setup
Install dependencies
yarn installCompiles and hot-reloads for development
yarn run serveCompiles and minifies for production
yarn run build:prodLints and fixes files
yarn run lintRun your unit tests
yarn run test:unitGenerate all svg components
yarn run svgCustomize Vue configuration
Browsers support
Modern browsers and Internet Explorer 10+.
 IE / Edge |
 Firefox |
 Chrome |
 Safari |
|---|---|---|---|
| IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions |
Contributing
See CONTRIBUTING.md