@unlk/keymaster

Table of Contents

1. 
   About The Project
   
   
   
   • Built With
   
   
   
   


2. 
   Getting Started
   
   
   
   • Prerequisites
   
   
   • Installation
   
   
   
   


3. Usage

About The Project

Keymaster is the shared visual and interactive language that guides how we build high-quality customer experience. It’s intended for use both internally at Unlock and externally by third-party developers and designers.

More specifically, we aim to:
* Make it easier for our customers and partners to do business with us by obscuring organizational boundaries, channels and technology stacks.
* Save time and money during the design and delivery phase.
* Ease collaboration and align teams.

(back to top)

$3

[![Bootstrap][Bootstrap.com]][Bootstrap-url]

[![Storybook][Storybook.js.org]][Storybook-url]

(back to top)

Getting Started

$3

The design system has a few dependencies that you will need to install before you can use it.
* Bootstrap 5
* Sass (Optional: If you want to compile the Sass files yourself.)

Keymaster also requires you to have Bootstrap 5 installed in your project as a peer-dependency.
If you do not have Bootstrap 5 installed, you can install it with the following command:

``sh
npm install bootstrap@5
`

Optional:
This project utilizes sass and requires you to have sass to compile our sources.
Alternatively, you can use the compiled CSS files in the dist folder.
If you do not have sass installed, you can install it with the following command:

`sh
// locally
npm install --save-dev sass


// or globally
npm install -g sass
`




$3


To install @unlk/keymaster in your project with npm, run the following command:

`sh
npm install @unlk/keymaster
`

(back to top)




Usage

To use the keymaster design system, you will need to import the scss file into your project.
This will import all of keymaster's styles and variables into your project.

`scss
@import '@unlk/keymaster/scss/keymaster.scss';
`

Alternatively, if you want to use the precompiled css, you can import the compiled css file into your project.

`css
@import '@unlk/keymaster/dist/css/keymaster.css';
`

Compiled CSS can be loaded from CDN as well
`html

`

You will also need to import the keymaster's javascript dependencies into your project.

`js
import '@unlk/keymaster/js/bootstrap.js';
`

Compiled JS can be loaded from CDN as well
`html

``

(back to top)

[product-screenshot]: images/screenshot.png
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[Storybook.js.org]: https://img.shields.io/badge/Storybook-ff4785?style=for-the-badge&logo=storybook&logoColor=white
[Storybook-url]: https://storybook.js.org/