Add Storybook into the boilerplate

.eslintignore

@@ -1,2 +1,3 @@
 node_modules
 out
+!.storybook

.eslintrc

@@ -84,6 +84,19 @@
       "parserOptions": {
         "project": "./cypress/tsconfig.json"
       }
+    },
+    // Configuration for Storybook
+    {
+      "files": ["*.stories.*"],
+      "extends": ["plugin:storybook/recommended"],
+      "rules": {
+        "import/no-extraneous-dependencies": [
+          "error",
+          {
+            "devDependencies": true
+          }
+        ]
+      }
     }
   ]
 }

.github/workflows/CI.yml

@@ -58,6 +58,9 @@ jobs:
       - name: Run unit tests
         run: npm run test
 
+      - name: Run storybook tests
+        run: npm run test-storybook:ci
+
       - name: Run e2e tests
         run: npx percy exec -- npm run e2e:headless
         env:

.gitignore

@@ -8,6 +8,9 @@
 # testing
 /coverage
 
+# storybook
+storybook-static
+
 # cypress
 cypress/screenshots
 cypress/videos

.storybook/main.ts

@@ -0,0 +1,22 @@
+import type { StorybookConfig } from '@storybook/nextjs';
+
+const config: StorybookConfig = {
+  stories: ['../src/**/*.stories.@(js|jsx|ts|tsx)'],
+  addons: [
+    '@storybook/addon-links',
+    '@storybook/addon-essentials',
+    '@storybook/addon-interactions',
+  ],
+  framework: {
+    name: '@storybook/nextjs',
+    options: {},
+  },
+  docs: {
+    autodocs: 'tag',
+  },
+  core: {
+    disableTelemetry: true,
+  },
+};
+
+export default config;

.storybook/preview.ts

@@ -0,0 +1,17 @@
+import '../src/styles/global.css';
+
+import type { Preview } from '@storybook/react';
+
+const preview: Preview = {
+  parameters: {
+    actions: { argTypesRegex: '^on[A-Z].*' },
+    controls: {
+      matchers: {
+        color: /(background|color)$/i,
+        date: /Date$/,
+      },
+    },
+  },
+};
+
+export default preview;

README.md

@@ -25,6 +25,7 @@ Developer experience first:
 - 🦺 Unit Testing with Jest and React Testing Library
 - 🧪 E2E Testing with Cypress
 - 👷 Run tests on pull request with GitHub Actions
+- 🎉 Storybook for UI development
 - 🎁 Automatic changelog generation with Semantic Release
 - 🔍 Visual testing with Percy (Optional)
 - 💡 Absolute Imports using `@` prefix