https://github.com/contentmunch/muncher-viz

A html5 svg and scss based visualization component library
https://github.com/contentmunch/muncher-viz

Last synced: about 1 month ago
JSON representation

A html5 svg and scss based visualization component library

• Host: GitHub
• URL: https://github.com/contentmunch/muncher-viz
• Owner: contentmunch
• License: mit
• Created: 2021-05-05T04:40:36.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-31T16:52:06.000Z (12 months ago)
• Last Synced: 2024-11-12T17:49:23.386Z (2 months ago)
• Language: TypeScript
• Size: 13.6 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Build release and publish](https://github.com/contentmunch/muncher-viz/workflows/Build%20release%20and%20publish/badge.svg)

# Muncher-Viz

A html5 svg and scss based [visualization component library](https://viz.muncher.dev/)

## Using Muncher-Viz

To use this component library:

* Add the npm package to your project

    ```

    $ npm install @contentmunch/muncher-viz

    ```

## Installation guide

In the project directory, you can run:

### `npm start`

Launches the component explorer on port 6010

### `npm test`

Launches the test runner in the interactive watch mode.


See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the package library.

## Coding rules

We use [GitHub Flow](https://guides.github.com/introduction/flow/) for our project workflow.

To ensure consistency throughout the source code, keep these rules in mind as you are working:

* Create pull request against develop to merge your code.

* All features or bug fixes **must be tested** by one or more [specs][unit-testing].

### Pull request format

```

* changes 1

* changes 2

fixes/closes #

```

### Git commit format

```

: 

 

 optional

```

* Any line of the commit message cannot be longer 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.

* The subject contains succinct description of the change:

    * use the imperative, present tense: "change" not "changed" nor "changes"

    * no dot (.) at the end

* Commit type:

    * feat: a new feature

    * fix: a bug fix

    * refactor: a code change that neither fixes a bug nor adds a feature

    * test: adding missing tests

    * chore: changes to the build process or auxiliary tools and libraries such as documentation generation