torchbox / torchbox/django-pattern-library
storybook-django: Storybook prototype of the pattern library
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 423
- Forks
- 53
- PR merge metrics
- No merged PRs in 30d
Description
Tracking issue for conversations relating to storybook-django, a prototype Storybook integration of the pattern library.
- Repository: https://github.com/torchbox/storybook-django
- Live demo: https://storybook-django.herokuapp.com/
- Side-by-side pattern library: https://storybook-django.herokuapp.com/pattern-library/
- @William-Blackie’s django-storybook
- Rails equivalent: https://github.com/jonspalmer/view_component_storybook
Related issues
All of the issues tagged storybook are related to this integration – either because the Storybook UI addresses them, or because using the pattern library through such an integration would drastically change the implementation.
Addressed by Storybook
Here are open issues that would no longer be relevant when using the pattern library with Storybook:
- #87 – Add support for pattern variants
- #102 – Add a way to customise the iframe dimensions by manually dragging
- #101 – Add option to customise breakpoints per-project
- #99 – Make pattern library UI WCAG 2.1 AA compliant
- #98 – Show the pattern name rather than the file path
- #97 – Hide directory structure for single patterns
- #96 – List patterns in alphabetical order
- #95 – Add ability to persist menu state
- #86 – Docs: Describe the approach to the base template which should include CSS and JS
- #92 – Add ability to view html/css/js for each pattern within the pattern library
And issues for which the implementation would be drastically simpler:
- #17 – Export static version of the pattern library hostable as a static site (Storybook already supports this, we would just need to implement this for the patterns’ rendering)
- #18 – Add a command to checks whether each template renders correctly (Storyshots addon + part of #17)
- #91 – Add support for pattern status (In progress, In review, Signed off etc) (Storybook probably has an addon for this)
- #100 – Add view showing multiple screen sizes next to each other at the same time (Storybook probably has an addon for this)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked storybook-django repository, its live demo, and the related Storybook issues listed here. This issue is a tracking point for conversations rather than a scoped change, so the files, tests, and completion criteria are not specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- frontend, tooling, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100