UTDNebula/survival-guide

[Internal] Implement Storybook library

Opened this issue · 0 comments

Overview of Changes

As a contributor to the project, I should be able to see a gallery of components used throughout the project.

Storybook is a tool that allows us to test components in isolation and together to ensure they look as designed and behave as intended.

Each of the following components should have a page in Storybook that documents all of their properties/states and behaviors:

  • Site-wide header
  • Site-wide footer
  • Navigation sidebar
  • Main content viewer (depending on #40).

Implementation Details

Storybook should be installed like it would for a React project that uses TypeScript. The website generated by Storybook should be accessible on a developer's local machine by running an NPM script like npm run storybook.

Supplementary Material

See the Figma document here for the full component specifications.

@SmokinTurkey or @legenung when you get the chance, could you share images of final components listed above?