Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coreui/bootstrap-vue

Bootstrap 5 components for Vue 3
https://github.com/coreui/bootstrap-vue

bootstrap bootstrap-5 bootstrap5 bootstrapvue vue vue-3 vue3

Last synced: 3 months ago
JSON representation

Bootstrap 5 components for Vue 3

Host: GitHub
URL: https://github.com/coreui/bootstrap-vue
Owner: coreui
License: mit
Created: 2021-12-19T14:12:03.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2021-12-20T19:25:38.000Z (about 3 years ago)
Last Synced: 2024-05-27T12:44:44.119Z (7 months ago)
Topics: bootstrap, bootstrap-5, bootstrap5, bootstrapvue, vue, vue-3, vue3
Language: TypeScript
Homepage: https://coreui.io/bootstrap-vue/
Size: 2.74 MB
Stars: 51
Watchers: 2
Forks: 3
Open Issues: 6
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

    

  





  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](#quick-start)

- [Status](#status)

- [What's included](#whats-included)

- [Bugs and feature requests](#bugs-and-feature-requests)

- [Documentation](#documentation)

- [Contributing](#contributing)

- [Community](#community)

- [Versioning](#versioning)

- [Creators](#creators)

- [Copyright and license](#copyright-and-license)

## Quick start

### Instalation

Several quick start options are available:

- [Download the latest release](https://github.com/coreui/bootstrap-vue/archive/v1.0.0.zip)

- Clone the repo: `git clone https://github.com/coreui/bootstrap-vue.git`

- Install with [npm](https://www.npmjs.com/): `npm install @coreui/bootstrap-vue`

- Install with [yarn](https://yarnpkg.com/): `yarn add @coreui/bootstrap-vue`

Read the [Getting started page](https://coreui.io/vue/docs/getting-started/introduction/) for information on the framework contents, templates and examples, and more.

### Stylesheets

Vue components are styled using `bootstrap` CSS library.

#### Installation

```bash

yarn add bootstrap

```

or

```bash

npm install bootstrap

```

#### Basic usage

```js

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

```

## Status

[![Build Status](https://github.com/coreui/bootstrap-vue/workflows/JS%20Tests/badge.svg?branch=main)](https://github.com/coreui/bootstrap-vue/actions?query=workflow%3AJS+Tests+branch%3Amain)

[![npm version](https://img.shields.io/npm/v/@coreui/bootstrap-vue)](https://www.npmjs.com/package/@coreui/bootstrap-vue)

[![peerDependencies Status](https://img.shields.io/david/peer/coreui/bootstrap-vue)](https://david-dm.org/coreui/bootstrap-vue?type=peer)

[![devDependency Status](https://img.shields.io/david/dev/coreui/bootstrap-vue)](https://david-dm.org/coreui/bootstrap-vue?type=dev)

[![Coverage Status](https://img.shields.io/coveralls/github/coreui/bootstrap-vue/v4)](https://coveralls.io/github/coreui/bootstrap-vue?branch=v4)

## Bugs and feature requests

Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/coreui/bootstrap-vue/blob/main/.github/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/coreui/bootstrap-vue/issues/new).

## Documentation

The documentation for the Bootstrap Vue is hosted at our website [Bootstrap Vue](https://coreui.io/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](https://github.com/coreui/bootstrap-vue/blob/main/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.

Editor preferences are available in the [editor config](https://github.com/coreui/bootstrap-vue/blob/main/.editorconfig) for easy use in common text editors. Read more and download plugins at .

## 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](https://blog.coreui.io/).

You can also follow [@core_ui on Twitter](https://twitter.com/core_ui).

## Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap Vue is maintained under [the Semantic Versioning guidelines](http://semver.org/).

See [the Releases section of our project](https://github.com/coreui/bootstrap-vue/releases) for changelogs for each release version.

## Creators

**Łukasz Holeczek**

- 

- 

**Andrzej Kopański**

- 

**The CoreUI Team**

- 

## Copyright and license

Copyright 2021 creativeLabs Łukasz Holeczek. Code released under the [MIT License](https://github.com/coreui/bootstrap-vue/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).