LoyaltyLion DS Component library

Installation

From the root of the application codebase run

yarn

Usage

import React, { Component } from 'react'

import MyComponent from 'll-design-system-component-library'
import 'll-design-system-component-library/dist/index.css'

class Example extends Component {
  render() {
    return <MyComponent />
  }
}

Contribution

Versioning

Before running a release, squash your commits to one with the following structure:

1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.

To bump patch version (X.X.1)

git commit -m "fix: update button colour"

To bump minor version (X.1.X)

git commit -m "feat: add modal component"

To bump major version (1.X.X)

git commit

feat: remove button component
BREAKING CHANGE: removed the button because blah

Publishing

Create a .env file in the root of your project folder.

echo "NPM_TOKEN={TOKEN}" >> .env

You will need to request NPM registry access token and replace placeholder in .env file.

To publish to NPM registry you will need to generate a .npmrc file.

From the root of the project run this command

sh ./scripts/generate_npmrc.sh

Once you have sorted .env & .npmrc files you should be able to publish to NPM registry by using this command

sh ./scripts/publish.sh

.