[![@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 next][npm-next]][npm] [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-next]: https://img.shields.io/npm/v/@coreui/vue/next.png?style=flat-square [npm]: https://www.npmjs.com/package/@coreui/vue # CoreUI Free Vue Admin Template v4 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) * [Quick Start](#quick-start) * [Installation](#installation) * [Basic usage](#basic-usage) * [What's included](#whats-included) * [Documentation](#documentation) * [Versioning](#versioning) * [Creators](#creators) * [Community](#community) * [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 React Admin Template](https://coreui.io/product/react-dashboard-template/) * 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/product/vue-dashboard-template/) ## 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 serve ``` or ``` bash # dev server with hot reload at http://localhost:3000 $ yarn serve ``` 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 `build/` 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 │ └── index.html # html template │ ├── src/ # project root │ ├── assets/ # images, icons, etc. │ ├── components/ # common components - header, footer, sidebar, etc. │ ├── layouts/ # layout containers │ ├── scss/ # scss styles │ ├── router # routes config │ └── store # template state example │ ├── views/ # application views │ ├── _nav.js # sidebar navigation config │ ├── App.vue │ ├── ... │ └── main.js │ └── package.json ``` ## Documentation The documentation for the CoreUI Admin Template is hosted at our website [CoreUI for Vue](https://coreui.io/vue/) ## Versioning For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI Free Admin Template is maintained under [the Semantic Versioning guidelines](http://semver.org/). See [the Releases section of our project](https://github.com/coreui/coreui-free-vue-admin-template/releases) for changelogs for each release version. ## Creators **Łukasz Holeczek** * * * **CoreUI team** * https://github.com/orgs/coreui/people ## Community Get updates on CoreUI's development and chat with the project maintainers and community members. - Follow [@core_ui on Twitter](https://twitter.com/core_ui). - Read and subscribe to [CoreUI Blog](https://coreui.io/blog/). ## Support CoreUI Development CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the [CoreUI PRO](https://coreui.io/pricing/) or by becoming a sponsor via [Open Collective](https://opencollective.com/coreui/). ### Platinum Sponsors Support this project by [becoming a Platinum Sponsor](https://opencollective.com/coreui/contribute/platinum-sponsor-40959/). A large company logo will be added here with a link to your website. ### Gold Sponsors Support this project by [becoming a Gold Sponsor](https://opencollective.com/coreui/contribute/gold-sponsor-40960/). A big company logo will be added here with a link to your website. ### Silver Sponsors Support this project by [becoming a Silver Sponsor](https://opencollective.com/coreui/contribute/silver-sponsor-40967/). A medium company logo will be added here with a link to your website. ### Bronze Sponsors Support this project by [becoming a Bronze Sponsor](https://opencollective.com/coreui/contribute/bronze-sponsor-40966/). The company avatar will show up here with a link to your OpenCollective Profile. ### Backers Thanks to all the backers and sponsors! Support this project by [becoming a backer](https://opencollective.com/coreui/contribute/backer-40965/). ## Copyright and License copyright 2023 creativeLabs Łukasz Holeczek. Code released under [the MIT license](https://github.com/coreui/coreui-free-react-admin-template/blob/main/LICENSE).