Miovision Design System

The Miovision Design System is our guide to building a consistent experience for our customers. It is our shared understanding of design that allows us to develop quickly.

We use Brad Frost’s Atomic Design as our core foundational elements. This is how we structure the building blocks of the design system.

There are 5 levels in atomic design:

1. Atoms
2. Molecules
3. Organisms
4. Templates
5. Pages

To learn more about Atomic Design, visit http://bradfrost.com/blog/post/atomic-web-design/

IDE / Editor Setup

Prettier

We are using Prettier for automatic code style formatting. Follow the guide below for proper IDE / Editor integration:

Prettier 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.

Style Guidelines

We have adopted the BEM methodology to organize our CSS. Please take a moment to get familiar with this convention by going over the following article:

MindBEMding – getting your head ’round BEM syntax Written by Harry Roberts on CSS Wizardry.

Development Setup

Project Structure

.
├── .storybook                              # Storybook configuration files
├── README.md
├── build                                   # Compiled files
├── gulpfile.js                             # Build tool configuration file
├── public                                  # Static files like images and videos for components and stories
├── src                                     # Source files
│   ├── components
│   └── style.css
└── vendor                                  # Third-party libraries

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

Local Development

# 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