Miovision Design System React Component Library
](link to site)
Getting started
# Add the library to your project
# Using npm
npm i -S @miovision/design-system @miovision/design-system-react
# Using yarn
yarn add @miovision/design-system @miovision/design-system-reactUsage
import ListAccordion from "@miovision/design-system-react/ListAccordion"
<ListAccordion title="Selected studies" dataset={dataset} />Contributing
The main purpose of this repository is to continue to evolve the Miovision Design System, making it faster and easier to use.
IDE / Editor Setup
Prettier
We are using Prettier for automatic code style formatting. Follow the guide below for proper IDE / Editor integration:
P.S for intelliJ users make sure you have the File Watchers plugin installed.
Git Commit Guidelines
We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the change log.
The commit message formatting can be added using a typical git workflow or through the use of a CLI wizard Commitizen. To use the wizard, run npm run cm in your terminal after staging your changes in git.
Installing Dependencies
Git: The Github Guide to Installing Git is a good source of information.
Node.js v8.x (LTS): We use Node to generate the documentation, run a development web server, run tests, and generate distributable files.
We recommend using nvm (or nvm-windows) to manage and install Node.js, which makes it easy to change the version of Node.js per project.
The commitizen command line utility: npm install commitizen -g
Development Setup
# Clone your Github repository:
git clone https://github.com/Miovision/design-system.git
# Go to the Design System directory:
cd design-system
# Install JavaScript dependencies:
npm install
# Build Design System:
npm start