@npmtestliffi/learnstorybook-design-system-template
v0.1.5
Published
1) Create reusable components based on [Figma design](https://www.figma.com/design/N0KxIxkd2feiy3IRG7XjfK/00.-Design-System-%5BExtracted%5D?node-id=311-4172&t=x5lUfUyISJABOWj4-0) - Inbox - Look into icons, typography and colors documentation/ theming - Ch
Downloads
254
Readme
Tasks for Storybook Demo
Create reusable components based on Figma design
- Inbox
- Look into icons, typography and colors documentation/ theming
- Change icon in main page of storybook app/ Styling for main app
- To Do
- Callout Banners
- Modal
- Snackbar
- UI Shell and Navigation
- In Progress
- Table
- Done
- Button
- TextField
- Dropdown
- Paper
- Empty/Error State Messages
- Inbox
Integrate qiankun MFEs with Storybook
- To Do
- Create MFEs with following libraries and versions
- React - v16.14.0
- Typescript - v4.6.3
- @mui/material - v5.11.15
- qiankun - v2.3.0
- Import and test Storybook functionality
- Create MFEs with following libraries and versions
- To Do
Containerisation with Docker
Version Management with Storybook e.g. how to manage different versions of reusable components being used in the frontend projects
explore plugin to streamline Figma process
Explore Testing solutions - playwright with storybook?
🚅 Quick start
Install the dependencies.
# Navigate to the directory cd learnstorybook-design-system/ # Install the dependencies yarn # Start storybook in port 6006 yarn storybook
🔎 What's inside?
A quick look at the top-level files and directories included with this template.
.
├── node_modules
├── src
├── .babelrc.json
├── .gitignore
├── .prettierignore
├── .prettierrc
├── LICENSE
├── package.json
├── rollup.config.mjs
├── vite.config.js
├── yarn.lock
└── README.md
node_modules
: This directory contains all of the modules of code that your project depends on (npm packages).src
: This directory will contain all of the code related to what you will see on your application..babelrc.json
: This file tells babel which presets and plugins to use when transforming your code..gitignore
: This file tells git which files it should not track or maintain during the development process of your project..prettierignore
: This file tells prettier which files it should not format..prettierrc
: This file tells prettier which rules to use when formatting your code.LICENSE
: The template is licensed under the MIT licence.package.json
: Standard manifest file for Node.js projects, which typically includes project specific metadata (such as the project's name, the author among other information). It's based on this file that npm will know which packages are necessary to the project.rollup.config.mjs
: This file tells rollup which plugins to use when bundling your code.yarn.lock
: This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (Do not change it manually).vite.config.js
: This file tells Vite which plugins to use when bundling your code.README.md
: A text file containing useful reference information about the project.
Learning Storybook
- Storybook development basics at Intro to Storybook.
- Redux knowledge recommended
- Learn how to transform your component libraries into design systems in our Design Systems for Developers tutorial.
- Includes more complete building deploy distribute flow but some deploy code seems outdated/not functioning
- Official documentation at Storybook.
- Sample Storybook from govuk
- React Managing State Tutorials
- Material UI Docs
- Helpful link for integrating MUI with Storybook(Typescript) here
- Figma integration addon
- React-hook-form-mui package might be useful for form validations
- How Paper component is designed for elevation
- Data Grid Getting Started and helpful list of features(free/paid) here