README.md

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

Report bug · Request feature · Blog

Table of contents

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

Quick start

Instalation

Several quick start options are available:

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

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

Stylesheets

Vue components are styled using bootstrap CSS library.

Installation

yarn add bootstrap

or

npm install bootstrap

Basic usage

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

Status

Bugs and feature requests

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

Documentation

The documentation for the Bootstrap Vue is hosted at our website Bootstrap Vue

Running documentation locally

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

Contributing

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

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

Community

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

• Read and subscribe to The Official CoreUI Blog.

You can also follow @core_ui on Twitter.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap Vue is maintained under the Semantic Versioning guidelines.

See the Releases section of our project for changelogs for each release version.

Creators

Ł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 and license

Copyright 2021 creativeLabs Łukasz Holeczek. Code released under the MIT License. Docs released under Creative Commons.