@ezaccess/ez-storybook v0.1.1

EZ-STORYBOOK

EZ-Storybook is a package for building UI components and pages in isolation. It streamlines UI development, testing, and documentation.

Installation for use

Install ez-storybook with npm

  npm install @ezaccess/ez-storybook

Update tailwind configs

Add ez-storybook to tailwind configs

content: [
    './src/pages/**/*.{js,ts,jsx,tsx}',
    './src/components/**/*.{js,ts,jsx,tsx}',
    './node_modules/@ezaccess/ez-storybook/**/*.{js,jsx,ts,tsx}'
  ],

Much of ez-storybook relies on tailwind themes. You will want to add these themes to your tailwind.config.js file in your project.

theme: {
    extend: {
      colors: {
        'primary': {
          '50': '#f4f9fc',
          '100': '#e9f2f9',
          '200': '#c8dff0',
          '300': '#a7cbe6',
          '400': '#64a4d4',
          '500': '#227dc1',
          '600': '#1f71ae',
          '700': '#1a5e91',
          '800': '#144b74',
          '900': '#113d5f'
      },
        'secondary': {
          '50': '#fff8f3',
          '100': '#fef1e8',
          '200': '#fedcc5',
          '300': '#fdc7a2',
          '400': '#fb9d5c',
          '500': '#f97316',
          '600': '#e06814',
          '700': '#bb5611',
          '800': '#95450d',
          '900': '#7a380b'
      }
      }
    },
  },

Run Locally

Clone the project

Go to the project directory

  cd my-project

Run on node 16.11.1

Install dependencies

  npm install

To run the project to view the storybook during development

  npm run storybook

This will open ez-storybook at port 6006

Build

To build and rollup changes

  npm run build

Publish

To publish this project to npm

  update the version in project.json

  major.minor.patch (0.0.0)

  npm publish