Demo: https://d2o7l66gzazilh.cloudfront.net/index.html

Demo: https://components.inspiritvr.com

🚅 Quick start

Usage

in main.css

@import "inspirit-ui-kit/dist/style.css"

on pages

import { ButtonTypes, InspiritButton } from 'inspirit-ui-kit'

Development

1. Install the dependencies.

   Navigate into your new site’s directory and install the necessary dependencies.

   # Install the dependencies
   npm install

2. Browse your stories!

   Run npm run storybook to see your component's stories at http://localhost:6006

3. Run Tests!

   Run npm run test-storybook

4. Build Storybook!

   Run `npm run build

5. Run Playwright test!

   Run npx playwright test

🔎 What's inside?

A quick look at the top-level files and directories included with this template.

.
├── .storybook
├── node_modules
├── public
├── src
    |── lib
    |── stories
    |── tests
├── .gitignore
├── LICENSE
├── package.json
└── README.md

1. .storybook: This directory contains Storybook's configuration files.

Semantic Release

semantic-release uses the commit messages to determine the consumer impact of changes in the codebase. Following formalized conventions for commit messages, semantic-release automatically determines the next semantic version number, generates a changelog and publishes the release.

By default, semantic-release uses Angular Commit Message Conventions. The commit message format can be changed with the preset or config options of the @semantic-release/commit-analyzer and @semantic-release/release-notes-generator plugins.

Tools such as commitizen or commitlint can be used to help contributors and enforce valid commit messages.

The table below shows which commit message gets you which release type when semantic-release runs (using the default configuration):

| Commit message | Release type | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | | fix(pencil): stop graphite breaking when too much pressure applied | ~~Patch~~ Fix Release | | feat(pencil): add 'graphiteWidth' option | ~~Minor~~ Feature Release | | perf(pencil): remove graphiteWidth optionBREAKING CHANGE: The graphiteWidth option has been removed.The default graphite width of 10mm is always used for performance reasons. | ~~Major~~ Breaking Release (Note that the BREAKING CHANGE: token must be in the footer of the commit) |