@edancerys/sooper-storybook

Copyright (c) 2022 Ed Ancerys

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

TS component library build with storybook & made to be imported as package (NPM) in to react application.

This is a Next.js project bootstrapped with create-next-app.

📌 Getting Started

Installing dependencies

yarn

First, run the development server:

npm run dev
# or
yarn dev

Component lib

• 👉 All components in lib are CSR only by default.
• 👉 All components that can be used SSR have SSR tag.

📌 Component lib class names

Class names all prefixed with "__" prefix to differentiate & not clash with application default class names. All components accept props to overwrite lib classes.

<!-- vercel.json -->
{
  "$schema": "https://openapi.vercel.sh/vercel.json",
  "buildCommand": "npm run build-storybook",
  "devCommand": "npm run storybook",
  "installCommand": "npm install",
  "framework": null,
  "outputDirectory": "./storybook-static"
}

📌 Build storybook only doc tapbs using flag --docs

<!-- vercel.json / package.json -->

"build-storybook": "build-storybook --docs"

Component lib list

TODO