https://github.com/icij/murmur

ICIJ's Design System for Bootstrap 4 and Vue 2.
https://github.com/icij/murmur

bootstrap component design-system icij ui vue

Last synced: 16 days ago
JSON representation

ICIJ's Design System for Bootstrap 4 and Vue 2.

• Host: GitHub
• URL: https://github.com/icij/murmur
• Owner: ICIJ
• Created: 2018-11-17T16:36:57.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-11-15T18:42:04.000Z (12 months ago)
• Last Synced: 2024-10-18T09:21:37.774Z (18 days ago)
• Topics: bootstrap, component, design-system, icij, ui, vue
• Language: Vue
• Homepage: https://icij.github.io/murmur/
• Size: 98.6 MB
• Stars: 16
• Watchers: 7
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  






Murmur is ICIJ's Design System for Bootstrap 4 and Vue.js





| | Status |

| --: | :-- |

| **CI checks** | [![CircleCI](https://circleci.com/gh/ICIJ/murmur.svg?style=shield)](https://circleci.com/gh/ICIJ/murmur) |

| **Code Climate** | [![Code Climate](https://api.codeclimate.com/v1/badges/e487295b939be72d5f15/maintainability)](ttps://codeclimate.com/github/ICIJ/murmur/maintainability) |

| **NPM version** | [![NPM version](https://img.shields.io/npm/v/@icij/murmur)](https://www.npmjs.com/package/@icij/murmur) |

| **NPM downloads** | [![NPM download](https://img.shields.io/npm/dm/@icij/murmur)](https://www.npmjs.com/package/@icij/murmur) |



## Installation guide

If you are using module bundlers such as Webpack or Rollup, you might need to include the package into your project.

To get started, use NPM or Yarn to get latest version of **@icij/murmur**.

```bash

# with NPM:

npm i @icij/murmur

# or with Yarn:

yarn add @icij/murmur

```

Then, register Murmur as a pluggin in your app entry point:

```js

import Vue from 'vue'

import Murmur from '@icij/murmur'

Vue.use(Murmur)

```

Now all components will be globally available in your app.

[Read the documentation](https://icij.github.io/murmur/) to know how to use them.

## Build Setup

``` bash

# install dependencies

yarn

# serve documentation with hot reload at localhost:8080

yarn serve

# build library and documentation for production with minification

yarn build

# build library for production with minification

yarn build:lib

# build documentation for production with minification

yarn build:docs

# deploy the doc on Github Pages

yarn deploy

# publish a version of the package on NPM registry

yarn publish

# run unit tests

yarn test:unit

```