{"_id":"@dvh-kaiser/kaiserin-storybook","name":"@dvh-kaiser/kaiserin-storybook","dist-tags":{"latest":"0.0.0"},"versions":{"0.0.0":{"name":"@dvh-kaiser/kaiserin-storybook","private":false,"version":"0.0.0","type":"module","scripts":{"build":"tsc && vite build","lint":"eslint --fix --ignore-path .eslintignore --ignore-pattern \"!**/.*\" .","prepare":"husky install","tsc":"tsc","storybook":"start-storybook -p 6006","build-storybook":"build-storybook"},"husky":{"hooks":{"pre-push":"ts-lint"},"ts-lint":{"src/**/*.{js,jsx,ts,tsx}":["yarn tsc","yarn lint"]}},"exports":{".":{"import":"./dist/kaiserin-storybook.es.js","require":"./dist/kaiserin-storybook.umd.js"},"./dist/style.css":"./dist/style.css"},"main":"./dist/kaiserin-storybook.umd.js","module":"./dist/kaiserin-storybook.es.js","types":"./dist/index.d.ts","repository":{"type":"git","url":"git+https://github.com/kaiser-io/kaiserin-storybook.git"},"author":{"name":"devops-hobbies"},"keywords":["component-library","react","react-component","devopshobbies","kaiser"],"license":"MIT","dependencies":{"react":"^18.2.0","react-dom":"^18.2.0"},"devDependencies":{"@babel/core":"^7.21.4","@babel/preset-env":"^7.20.2","@babel/preset-react":"^7.18.6","@babel/preset-typescript":"^7.21.0","@storybook/addon-actions":"^6.5.16","@storybook/addon-essentials":"^6.5.16","@storybook/addon-interactions":"^6.5.16","@storybook/addon-links":"^6.5.16","@storybook/builder-vite":"^0.4.2","@storybook/react":"^6.5.16","@storybook/testing-library":"^0.0.13","@types/node":"^18.15.11","@types/react":"^18.0.28","@types/react-dom":"^18.0.11","@types/styled-components":"^5.1.26","@typescript-eslint/eslint-plugin":"^5.54.1","@typescript-eslint/parser":"^5.54.1","@vitejs/plugin-react":"^3.1.0","autoprefixer":"^10.4.14","babel-loader":"^8.3.0","babel-plugin-transform-import-meta":"^2.2.0","eslint":"^8.37.0","eslint-config-airbnb":"^19.0.4","eslint-config-prettier":"^8.7.0","eslint-import-resolver-alias":"^1.1.2","eslint-plugin-import":"^2.27.5","eslint-plugin-jsx-a11y":"^6.7.1","eslint-plugin-prettier":"^4.2.1","eslint-plugin-react":"^7.32.2","eslint-plugin-storybook":"^0.6.11","husky":"^8.0.0","postcss":"^8.4.21","prettier":"^2.8.4","styled-components":"^5.3.8","tailwindcss":"^3.2.7","typescript":"^4.9.3","vite":"^4.2.0","vite-plugin-dts":"^2.2.0","vite-plugin-linter":"^2.0.2","vite-tsconfig-paths":"^4.0.8"},"gitHead":"47ffa7ba405a2413fb33f092e64704f2afe254a5","description":"# Table of Contents","bugs":{"url":"https://github.com/kaiser-io/kaiserin-storybook/issues"},"homepage":"https://github.com/kaiser-io/kaiserin-storybook#readme","_id":"@dvh-kaiser/kaiserin-storybook@0.0.0","_nodeVersion":"18.8.0","_npmVersion":"8.18.0","dist":{"integrity":"sha512-KpEo+1+xXXyTXL1fFHXzj6wVJKTJdPgL5B7W5qwm065HnVRxPH0iLDeot371O7JgEJcsWIjP9u+lrXSPkbH35w==","shasum":"f23e7ab881fbc7249d2a7ed4ae9346a01b922b1b","tarball":"https://registry.npmjs.org/@dvh-kaiser/kaiserin-storybook/-/kaiserin-storybook-0.0.0.tgz","fileCount":12,"unpackedSize":148237,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA3w83lpMhTHQxu06GdVDxI6vi1IDMBjGfIQOkgoaqJQAiEA5px8D9/TnAaPWCRqmto8hYAIoYVrkDuFRXlpKCNbIdk="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkRm8kACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq6yw/+IHrFfz+jRPsW+jQ1OOazxgp224mYLJvCZHagxVtygJTu4dzk\r\nXElQRo8BmlAnJwFPtqeoLbvPfBbg6IDD0NdyvZ8JsocvypT+e3klq8aFZhUd\r\nnQQm14JjdaTjFyJCqvDyoXokcYCSFV/4kMeJej6W2z1BpGQzjIzbmw1lGLeV\r\n3uR9xqALbdIy1y/oEsnBY0XOjklGy2zdOrAiZVrGWcc7GH3GNQ1GF0LAydMT\r\n5uZggiqV8M7y+S3ZiHA6fS6kJaoxULOJvuJQdrY3qKwpYDxNism7QviH4wU+\r\nAHocTzsyqOW86T8QKAEOqcRoQtTqXsEEWyILZWSCILJpZ6ZaSSEExEg0X6+2\r\ngi/+MknAXwQwYx8uw3C5v5SwcMyHnDCw1GSJIodBbp3L1wcaKWqKBv9gyAlu\r\ndgdLjezZ/7ZgXei1kvFQvFkI/vzs5sEfth/Zey5zjpL1GYgvZo8yJPUHCBp4\r\noORCrw5a1YHuM+20HClCTtWIOlkbA8lTnWo4h4CdNRbyQo/HMo+YUWZZ1yl4\r\nhSAMtGyDemo4FVJ9vv2r90lS0JmwmrrfFST6NVlUgT9ZoRW8fRaxMI1FTx5A\r\nnjKA097NzigDXG6MsTWltP++yiZLEO1r31Ql6LKXsvncTQHje+NUr7Bj+vC3\r\n8F+SgNkp0wp1vV20nyM7p3M/I4YBmUy8ixk=\r\n=s0j9\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"behnamrhp","email":"behnamrahimpour74@gmail.com"},"directories":{},"maintainers":[{"name":"behnamrhp","email":"behnamrahimpour74@gmail.com"},{"name":"devopshobbies","email":"moeid@devopshobbies.com"},{"name":"babakdorani","email":"babak@devopshobbies.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/kaiserin-storybook_0.0.0_1682337572771_0.2767584323206993"},"_hasShrinkwrap":false}},"time":{"created":"2023-04-24T11:59:32.687Z","0.0.0":"2023-04-24T11:59:32.962Z","modified":"2023-04-24T11:59:33.147Z"},"maintainers":[{"name":"behnamrhp","email":"behnamrahimpour74@gmail.com"},{"name":"devopshobbies","email":"moeid@devopshobbies.com"},{"name":"babakdorani","email":"babak@devopshobbies.com"}],"description":"# Table of Contents","homepage":"https://github.com/kaiser-io/kaiserin-storybook#readme","keywords":["component-library","react","react-component","devopshobbies","kaiser"],"repository":{"type":"git","url":"git+https://github.com/kaiser-io/kaiserin-storybook.git"},"author":{"name":"devops-hobbies"},"bugs":{"url":"https://github.com/kaiser-io/kaiserin-storybook/issues"},"license":"MIT","readme":"# Kaiserin Storybook\n\n# Table of Contents\n\n- [Kaiser](#kaiserin-storybook)\n- [Overview](#overview)\n- [Technologies](#technologies)\n- [Getting Started Storybook](#getting-started-storybook)\n  - [Development](#development)\n  - [Production](#production)\n- [Naming Conventions](#naming-convetions)\n\n## Overview\n\n`Kaiserin storybook` is a project based on the Kaiserin design that has been implemented as a library component.\n\n### Technologies\n\n- language: [Typescript](https://www.typescriptlang.org/)\n- framework: [React](https://reactjs.org/)\n- lintins: [ESlint](https://eslint.org/)\n- module bundler: [Vite](https://vitejs.dev/)\n- css framework: [Tailwindcss](https://tailwindcss.com/)\n- storybook: [Storybook](https://storybook.js.org/docs/)\n\n## Folder Structuring\n\nin this project we follow the folder structuring based on component categories\n\n> note: for more information about component categories please visit [full-documentation](./full-documentation/full-documentation.md)\n\n```bash\n.\n└── src/\n    ├── components/\n    │   ├── Input/\n    │   │   └── Button/\n    │   │       ├── story/\n    │   │       │   ├── button.stories.tsx\n    │   │       │   └── template.tsx\n    │   │       ├── prototype/\n    │   │       │   └── buttonProto.ts\n    │   │       ├── button.tsx\n    │   │       └── style.ts\n    │   └── Surface/\n    │       └── app-bar/\n    │           ├── story/\n    │           │   ├── AppBar.stories.tsx\n    │           │   └── template\n    │           ├── prototype/\n    │           │   └── appBarProto.ts\n    │           ├── AppBar.tsx\n    │           └── AppBar.module.css\n    └── utils/\n        ├── assets/\n        │   └── icons\n        ├── configs\n        ├── helpers\n        └── static-data\n```\n\n## Getting Started Storybook\n\nyou can start storybook of the library project in two ways: running simple, running with Docker\n\n### Development\n\n```bash\n yarn dev | npm run dev\n```\n\n### Production\n\n#### Build and Run with Docker\n\n```bash\n  docker-compose -f docker-compose.yml up [-d] [--build] [--foce-recreate]\n```\n\n## naming convetions:\n\n1. all **_folders_** follow the kebab-case convention for naming.\n2. all **_files_** follow the camelCase convention for naming.\n3. all **_variables_** and **_functions_** follow the camelCase convention for naming.\n","readmeFilename":"Readme.md"}