@visitscotland/component-library/README.md

VisitScotland Component Library

# VisitScotland Component Library
[![VisitScotland](https://img.shields.io/badge/visitscotland-5B2487.svg)](https://github.com/visitscotland/)
[![npm version](https://badge.fury.io/js/@visitscotland%2Fcomponent-library.svg)](https://badge.fury.io/js/@visitscotland%2Fcomponent-library)
[![Vue: 3](https://img.shields.io/badge/Vue-3-41B883.svg)](https://vuejs.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Yarn Test](https://github.com/visitscotland/vs-component-library/actions/workflows/test.yml/badge.svg)](https://github.com/visitscotland/vs-component-library/actions/workflows/test.yml)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)

This is the repository for the **VisitScotland Component Library** which contains all the components that can be used to build user interfaces for VisitScotland.

## Getting started

Clone the repository then install the package:

```sh
yarn install
```
To set up a development environment, you will need to create a .env file with the necessary environment variables then you can run Storybook with this command:

```sh
yarn storybook
```

## Installation
The component library can be installed via NPM to be used in your project.

To install the VisitScotland Component Library in your project, run the following command using npm:

```sh
npm install @visitscotland/component-library
```

If using Yarn, use the following command instead:

```sh
yarn add @visitscotland/component-library
```

## Contribution
Before contributing, please read our [contribution guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md).

## License
[MIT](https://choosealicense.com/licenses/mit/)

## Thanks
<a href="https://www.chromatic.com/"><img src="https://user-images.githubusercontent.com/321738/84662277-e3db4f80-af1b-11ea-88f5-91d67a5e59f6.png" width="153" height="30" alt="Chromatic" /></a>

Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions.