Skip to content

openfresno/fe-openfresno.org-doc

Repository files navigation

Open Fresno website documentation

This repository hosts the Storybook + Next.js testing environment for the Open Fresno website. It provides a sandbox for building, documenting, and testing UI components in isolation before they are integrated into the main site.

Note

The Open Fresno website repository is github.com/openfresno/openfresno.org.

Warning

The code should be periodically kept up to date with the main repository by manually copy/pasting the src/ folder.

Prerequisites

Get Started

  1. Install the Node.js dependencies.

    pnpm i
    
  2. Start the Storybook development server.

    pnpm storybook
    
  3. (Optional) Preview the regular Next.js website.

    pnpm dev
    

Testing

Storybook

The public Storybook is deployed to GitHub Pages at https://openfresno.github.io/fe-openfresno.org-doc/. You can learn about the components and also run tests.

Playwright

Visual regression and interaction tests. These tests also contain critical tests that should be included in the main website repository for use in CI/CD pipelines.

Vitest

Unit tests and coverage.

Resources