VisitScotland Component Library

![VisitScotland](https://github.com/visitscotland/)
![npm version](https://badge.fury.io/js/@visitscotland%2Fcomponent-library)
![Vue: 3](https://vuejs.org/)
![License: MIT](https://opensource.org/licenses/MIT)
![Yarn Test](https://github.com/visitscotland/vs-component-library/actions/workflows/test.yml)

![Contributor Covenant](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 and code of conduct.

License

MIT

Thanks

Thanks to Chromatic for providing the visual testing platform that helps us review UI changes and catch visual regressions.