{"id":20617962,"url":"https://github.com/applitools/tutorial-storybook-react","last_synced_at":"2025-07-04T12:07:18.126Z","repository":{"id":33923586,"uuid":"152121368","full_name":"applitools/tutorial-storybook-react","owner":"applitools","description":"Applitools Eyes tutorial using Storybook with React","archived":false,"fork":false,"pushed_at":"2025-05-06T14:00:59.000Z","size":6228,"stargazers_count":4,"open_issues_count":9,"forks_count":6,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-06T15:04:43.092Z","etag":null,"topics":["eyes","storybook","storybook-react-tutorial"],"latest_commit_sha":null,"homepage":"https://info.applitools.com/ucy78","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/applitools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-10-08T17:44:25.000Z","updated_at":"2025-05-06T14:01:03.000Z","dependencies_parsed_at":"2025-05-06T15:07:01.504Z","dependency_job_id":null,"html_url":"https://github.com/applitools/tutorial-storybook-react","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/applitools/tutorial-storybook-react","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/applitools%2Ftutorial-storybook-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/applitools%2Ftutorial-storybook-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/applitools%2Ftutorial-storybook-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/applitools%2Ftutorial-storybook-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/applitools","download_url":"https://codeload.github.com/applitools/tutorial-storybook-react/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/applitools%2Ftutorial-storybook-react/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263507898,"owners_count":23477406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eyes","storybook","storybook-react-tutorial"],"created_at":"2024-11-16T12:06:39.410Z","updated_at":"2025-07-04T12:07:18.121Z","avatar_url":"https://github.com/applitools.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Applitools Tutorial - Storybook React\n\nGet started with Applitools Eyes visual testing with this example of using [Storybook](https://storybook.js.org/) and our [Eyes Storybook SDK](https://applitools.com/tutorials/sdks/storybook).\n\nLearn more about how to install and start this project with our [Storybook tutorial](https://applitools.com/tutorials/sdks/storybook)!\n\n_If you're looking for the CSF format for creating Storybook stories, check out the [Storybook CSF React tutorial](https://github.com/applitools/tutorial-storybook-csf-react)._\n\n# Installation \u0026 Run\n1. Install the dependencies\n    ```sh\n    npm install\n    ```\n\nTo authenticate via the Applitools server and run tests, you need to set your API key provided from Applitools Eyes. For details on how to retrieve your API key, see [the Applitools documentation](https://applitools.com/tutorials/getting-started/retrieve-api-key).\n\n2. Choose one of the following options to set your API Key.\n    * Set your Applitools API Key as an environment variable. \n        * macOS/Linux: `export APPLITOOLS_API_KEY=\u003cYour API Key\u003e`\n        * Windows: `set APPLITOOLS_API_KEY=\u003cYour API Key\u003e`\n        \n    * Set your Applitools API Key inside the **applitools.config.js** file via the `apiKey` setting.\n        * Note: If you are not using the Eyes public cloud, you will need to update the `serverUrl` to your Eyes server URL in the **applitools.config.js** configuration file or set via an `APPLITOOLS_SERVER_URL` environment variable. See our [documentation](https://applitools.com/tutorials/sdks/storybook/config) for more information on these settings.\n\n3. Run the example test\n    ```sh\n    npx eyes-storybook\n    ```\n\n4. After the example tests complete. Visit your Applitools Eyes dashboard to view the results.\n\n## More Information\n\nLearn more about [Applitools Eyes](https://www.applitools.com) and the [Applitool Ultrafast Grid](https://applitools.com/platform/ultrafast-grid).\n\nMore about the Eyes Storybook SDK:\n* https://www.npmjs.com/package/@applitools/eyes-storybook\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapplitools%2Ftutorial-storybook-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapplitools%2Ftutorial-storybook-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapplitools%2Ftutorial-storybook-react/lists"}