Everchron Shards

This repository contains the design system and Vue components for the Everchron web application.

You will need the following software to setup the development environment. The titles under "Software" in the grid below are linked to the procedures you need to follow.

| Software | Install (macOS) | Install (Linux) | Install (Windows) | |------------------------------------------------------|-------------------------------|-------------------------------|-------------------------------| Node | Follow Site Instructions | Follow Site Instructions | N/A | Yarn | npm -g install yarn | Follow Site Instructions | N/A |

Expected node version: 6.* || 8.* || >= 10.*

Getting Started

Project setup

Run the commad below to install the dependencies:

yarn install

Compiles and hot-reloads for app development:

yarn serve

Compiles and builds package

yarn run build-bundle

Publishes built package to npm

yarn publish --access public

Storybook

Storybook provides a sandbox to build UI components in isolation. You can view Storybook hosted on Github pages here. To compile stories and run Storybook locally, run:

yarn storybook

To view Storybook visit http://localhost:6006/ in your browser.

To build a static version of Storybook, that is hosted on Github pages, run:

yarn build-storybook --docs

Guidelines

Visit wiki page to learn more about the architecture, guidelines and code principles of this project.