Repository files navigation

Vue.js Components Library built on top of Bootstrap 5 and TypeScript.
Explore CoreUI for Vue.js docs »

Report bug ·Request feature ·Blog

• Quick start
• Status
• What's included
• Bugs and feature requests
• Documentation
• Contributing
• Community
• Versioning
• Creators
• Copyright and license

Several quick start options are available:

• Download the latest release
• Clone the repo:git clone https://github.com/coreui/coreui-vue.git
• Install withnpm:npm install @coreui/vue
• Install withyarn:yarn add @coreui/vue

Read theGetting started page for information on the framework contents, templates and examples, and more.

Vue components are styled using@coreui/coreui CSS library, but you can use them also with bootstrap CSS library. That is possible because@coreui/coreui library is compatible with bootstrap, it just extends its functionalities. The only exception are custom CoreUI components, which don't exist in the Bootstrap ecosystem.

yarn add @coreui/coreui

or

npm install @coreui/coreui --save

import'@coreui/coreui/dist/css/coreui.min.css'

yarn add bootstrap

or

npm install bootstrap

import"bootstrap/dist/css/bootstrap.min.css";

Have a bug or a feature request? Please first read theissue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet,please open a new issue.

The documentation for the CoreUI & CoreUI PRO is hosted at our websiteCoreUI for Vue

1. Runyarn install ornpm install to install the Node.js dependencies.
2. Runyarn bootstrap ornpm run bootstrap to link local packages together and install remaining package dependencies.
3. From the root directory, runyarn docs:dev ornpm run docs:dev (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
4. Openhttp://localhost:8000/ in your browser, and voilà.

Please read through ourcontributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Editor preferences are available in theeditor config for easy use in common text editors. Read more and download plugins athttps://editorconfig.org/.

Stay up to date on the development of CoreUI and reach out to the community with these helpful resources.

• Read and subscribe toThe Official CoreUI Blog.

You can also follow@core_ui on Twitter.

For transparency into our release cycle and in striving to maintain backward compatibility, CoreUI is maintained underthe Semantic Versioning guidelines.

Seethe Releases section of our project for changelogs for each release version.

Łukasz Holeczek

• https://twitter.com/lukaszholeczek
• https://github.com/mrholek

Andrzej Kopański

• https://github.com/xidedix

The CoreUI Team

• https://github.com/orgs/coreui/people

Copyright 2021 creativeLabs Łukasz Holeczek. Code released under theMIT License. Docs released underCreative Commons.