Northeastern-Electric-Racing / Northeastern-Electric-Racing/FinishLine

[Frontend] - Setup a Storybook

Open
#1,748 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

spike
Dominant language
TypeScript
Stars
36
Forks
9
Avg merge
4d 21h
Merged PRs (30d)
11

Description

Spike Type

Technical

Goal

Storybook is a frontend workshop for building UI components and pages in isolation. Thousands of teams use it for UI development, testing, and documentation.

This spike is to setup a storybook for NER and to port some of our existing components into it.

Reason for Spike

Creating a storybook would better educate new members, document existing components, and improve the components that we have. It would also serve as pretty easy, low priority tickets for new ppl.

Additional notes

https://storybook.js.org/

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing frontend components and the Storybook setup guidance at storybook.js.org. Done means NER has a working Storybook with some existing components ported into it; the issue does not identify files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
storybook, typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.