# CoreUI Free Vue Admin Template - Built for AI-Assisted Development [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/intent/tweet?text=CoreUI%20-%20Free%Vue%204%20Admin%20Template%20&url=https://coreui.io&hashtags=bootstrap,admin,template,dashboard,panel,free,angular,react,vue) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT) [![@coreui coreui](https://img.shields.io/badge/@coreui%20-coreui-lightgrey.svg?style=flat-square)](https://github.com/coreui/coreui) [![npm package][npm-coreui-badge]][npm-coreui] [![NPM downloads][npm-coreui-download]][npm-coreui] [![@coreui vue](https://img.shields.io/badge/@coreui%20-vue-lightgrey.svg?style=flat-square)](https://github.com/coreui/vue) [![npm package][npm-coreui-vue-badge]][npm-coreui-vue] [![NPM downloads][npm-coreui-vue-download]][npm-coreui-vue] [npm-coreui]: https://www.npmjs.com/package/@coreui/coreui [npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square [npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square [npm-coreui-vue]: https://www.npmjs.com/package/@coreui/vue [npm-coreui-vue-badge]: https://img.shields.io/npm/v/@coreui/vue.png?style=flat-square [npm-coreui-vue-download]: https://img.shields.io/npm/dm/@coreui/vue.svg?style=flat-square [npm]: https://www.npmjs.com/package/@coreui/vue [![Bootstrap Admin Template](https://assets.coreui.io/products/coreui-free-bootstrap-admin-template-light-dark.webp)](https://coreui.io/product/free-react-admin-template/) CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of redundant components, so the app is light enough to offer ultimate user experience. This means mobile devices also, where the navigation is just as easy and intuitive as on a desktop or laptop. The CoreUI Layout API lets you customize your project for almost any device – be it Mobile, Web or WebApp – CoreUI covers them all! ## Table of Contents * [Versions](#versions) * [CoreUI PRO](#coreui-pro) * [CoreUI PRO Vue Admin Templates](#coreui-pro-vue-admin-templates) * [Quick Start](#quick-start) * [Installation](#installation) * [Basic usage](#basic-usage) * [What's included](#whats-included) * [AI-Friendly Development](#ai-friendly-development) * [Documentation](#documentation) * [Components](#components) * [Versioning](#versioning) * [Creators](#creators) * [Community](#community) * [Support CoreUI Development](#support-coreui-development) * [Copyright and License](#copyright-and-license) ## Versions * [CoreUI Free Bootstrap Admin Template](https://github.com/coreui/coreui-free-bootstrap-admin-template) * [CoreUI Free Angular Admin Template](https://github.com/coreui/coreui-free-angular-admin-template) * [CoreUI Free React.js Admin Template](https://github.com/coreui/coreui-free-react-admin-template) * [CoreUI Free Vue.js Admin Template](https://github.com/coreui/coreui-free-vue-admin-template) ## CoreUI PRO * 💪 [CoreUI PRO Angular Admin Template](https://coreui.io/product/angular-dashboard-template/) * 💪 [CoreUI PRO Bootstrap Admin Template](https://coreui.io/product/bootstrap-dashboard-template/) * 💪 [CoreUI PRO Next.js Admin Template](https://coreui.io/product/next-js-dashboard-template/) * 💪 [CoreUI PRO React Admin Template](https://coreui.io/product/react-dashboard-template/) * 💪 [CoreUI PRO Vue Admin Template](https://coreui.io/product/vue-dashboard-template/) ## CoreUI PRO Vue Admin Templates | Default Theme | Light Theme | | --- | --- | | [![CoreUI PRO Vue Admin Template](https://coreui.io/images/templates/coreui_pro_default_light_dark.webp)](https://coreui.io/product/vue-dashboard-template/?theme=default) | [![CoreUI PRO Vue Admin Template](https://coreui.io/images/templates/coreui_pro_light_light_dark.webp)](https://coreui.io/product/vue-dashboard-template/?theme=light)| | Modern Theme | Bright Theme | | --- | --- | | [![CoreUI PRO Vue Admin Template](https://coreui.io/images/templates/coreui_pro_default_v3_light_dark.webp)](https://coreui.io/product/vue-dashboard-template/?theme=modern) | [![CoreUI PRO Vue Admin Template](https://coreui.io/images/templates/coreui_pro_light_v3_light_dark.webp)](https://coreui.io/product/vue-dashboard-template/?theme=bright)| ## Quick Start - [Download the latest release](https://github.com/coreui/coreui-free-vue-admin-template/archive/refs/heads/main.zip) - Clone the repo: `git clone https://github.com/coreui/coreui-free-vue-admin-template.git` ### Instalation ``` bash $ npm install ``` or ``` bash $ yarn install ``` ### Basic usage ``` bash # dev server with hot reload at http://localhost:3000 $ npm run dev ``` or ``` bash # dev server with hot reload at http://localhost:3000 $ yarn dev ``` Navigate to [http://localhost:3000](http://localhost:3000). The app will automatically reload if you change any of the source files. #### Build Run `build` to build the project. The build artifacts will be stored in the `dist/` directory. ```bash # build for production with minification $ npm run build ``` or ```bash # build for production with minification $ yarn build ``` ## What's included Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this: ``` coreui-free-vue-admin-template ├── public/ # static files ├── src/ # project root │ ├── assets/ # images, icons, etc. │ ├── components/ # common components - header, footer, sidebar, etc. │ ├── layouts/ # layout containers │ ├── scss/ # scss styles │ ├── router # routes config │ ├── stores/ # template state example │ ├── views/ # application views │ ├── _nav.js # sidebar navigation config │ ├── App.vue │ ├── ... │ └── main.js ├── index.html # html template ├── package.json └── vite.config.mjs ``` ## AI-Friendly Development This template is designed to work seamlessly with AI coding assistants like Cursor, GitHub Copilot, and Claude Code. We've included comprehensive documentation and configuration files to help AI understand the project structure and conventions. ### Features for AI Development - **`.cursorrules`**: Complete AI assistant configuration with project conventions, technology stack, and coding patterns - **`ARCHITECTURE.md`**: Detailed technical architecture documentation covering components, routing, state management, and build system - **`DEVELOPMENT.md`**: Comprehensive development guide with setup instructions, workflows, and best practices - **JSDoc Comments**: Main Vue components include documentation for better AI understanding ### Getting Started with AI Assistants 1. **Open the project** in your AI-powered IDE (VS Code with Cursor, GitHub Copilot, or Claude Code) 2. **Review `.cursorrules`** to understand the project conventions 3. **Ask your AI assistant** to help you build features - it will automatically follow the project patterns 4. **Use natural language** to describe components, pages, or features you want to add ### What AI Assistants Know About This Project Your AI assistant understands: - **Component Library**: Always use CoreUI Vue components (never Tailwind, Vuetify, or other libraries) - **Code Style**: Vue 3 Composition API with `