The-DevOps-Daily / The-DevOps-Daily/devops-daily
feat: Add Storybook for component development
Open
Nobody has claimed this yet.
enhancement
good first issue
hacktoberfest
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 392
- Avg merge
- 5h 8m
- Merged PRs (30d)
- 121
Description
Description
Set up Storybook for isolated component development, documentation, and testing.
Problem
- No isolated environment for developing components
- Difficult to test components in different states
- No visual component documentation
- Hard to catch visual regressions
- New contributors need to understand component API
Benefits of Storybook
- Develop components in isolation
- Document component props and variations
- Visual testing and regression detection
- Accessibility testing integration
- Easier onboarding for contributors
- Component library showcase
Components to Document (Priority)
components/quizzes-hero.tsx- Animated herocomponents/games/quiz-manager.tsx- Quiz cardscomponents/game-card.tsx- Game cardscomponents/code-block.tsx- Syntax highlightingcomponents/markdown-content.tsx- Markdown rendering- All shadcn/ui components in use
Acceptance Criteria
- Install and configure Storybook 8
- Configure for Next.js 15 and React 19
- Set up TypeScript support
- Configure Tailwind CSS
- Add stories for 5+ key components
- Add accessibility addon
- Add responsive viewport addon
- Document component props
- Add GitHub Actions workflow for Storybook build
- Optional: Deploy Storybook to Chromatic or GitHub Pages
Files to Create
.storybook/main.ts- Storybook config.storybook/preview.ts- Global decoratorsstories/*.stories.tsx- Component stories.github/workflows/storybook.yml- CI workflow
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 inspecting the five priority components, the shadcn/ui components in use, and the existing Next.js 15, React 19, TypeScript, and Tailwind CSS setup. Create .storybook/main.ts, .storybook/preview.ts, stories/*.stories.tsx, and .github/workflows/storybook.yml; done means Storybook builds with 5+ documented component stories, accessibility and viewport addons, and a passing CI workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, next.js, react, tailwindcss, typescript
- Domain
- accessibility, ci-cd, frontend, testing-qa, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100