@applitools/eyes-storybook/README.md

## Applitools Eyes SDK for [Storybook](http://storybook.js.org).

## Installation

### Install npm package

Install Eyes-Storybook as a local dev dependency in your tested project:

```bash
npm install --save-dev @applitools/eyes-storybook
```

### Entering the Applitools API key {#API}

To authenticate via the Applitools server and run tests, you need to set the environment variable `APPLITOOLS_API_KEY` to the API key provided from Applitools Eyes. For details on how to retrieve your API key, see [the Applitools documentation](/getting-started/retrieve-api-key).

#### Entering the API Key on Linux or a Mac


```bash
export APPLITOOLS_API_KEY=<API_key>
```

#### Entering the API Key on Windows


```bash
set APPLITOOLS_API_KEY=<API_key>
```

## Further information

For further information, see:

* [Quickstart](https://applitools.com/tutorials/sdks/storybook-react/quickstart)
* [Overview](https://applitools.com/tutorials/sdks/storybook)
* [Changelog](https://applitools.com/tutorials/sdks/storybook/changelog)