8000 GitHub - intelliBrain/coreui-vue: Bootstrap 5 based Vue 3 components and directives. CoreUI for Vue.js replaces and extends the Bootstrap 5 javascript. Components have been built from scratch as true Vue 3 components.
[go: up one dir, main page]
Skip to content
/ coreui-vue Public
forked from coreui/coreui-vue

Bootstrap 5 based Vue 3 components and directives. CoreUI for Vue.js replaces and extends the Bootstrap 5 javascript. Components have been built from scratch as true Vue 3 components.

coreui.io/vue/docs/4.0/getting-started/introduction.html

License

MIT license
0 stars 131 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

intelliBrain/coreui-vue

BranchesTags
 
 

Repository files navigation

CoreUI logo

CoreUI for Vue.js

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

Report bug · Request feature · Blog

Table of contents

Quick start

Instalation

Several quick start options are available:

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

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

Stylesheets

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.

CoreUI CSS files

Installation
yarn add @coreui/coreui

or

npm install @coreui/coreui --save
Basic usage
import '@coreui/coreui/dist/css/coreui.min.css'

Bootstrap CSS files

Installation
yarn add bootstrap

or

npm install bootstrap
Basic usage
import "bootstrap/dist/css/bootstrap.min.css";

Status

Build Status npm version peerDependencies Status devDependency Status Coverage 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 CoreUI & CoreUI PRO is hosted at our website CoreUI for 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 CoreUI and reach out to the community with these helpful resources.

You can also follow @core_ui on Twitter.

Versioning

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

See the Releases section of our project 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. Docs released under Creative Commons.

About

Bootstrap 5 based Vue 3 components and directives. CoreUI for Vue.js replaces and extends the Bootstrap 5 javascript. Components have been built from scratch as true Vue 3 components.

coreui.io/vue/docs/4.0/getting-started/introduction.html

Resources

Readme

License

MIT license

Code of conduct

Code of conduct
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

73 tags

Packages

No packages published

Languages

  • TypeScript 91.5%
  • SCSS 4.6%
  • Vue 3.0%
  • JavaScript 0.9%
0