Skip to content

Files

Latest commit

f9f999e · Jan 18, 2025

History

History
32 lines (22 loc) · 980 Bytes

README.md

File metadata and controls

32 lines (22 loc) · 980 Bytes

Design System

This is Bits of Good's Design System, which is an internal collection of components to standardize our designs.

Viewing Our Components

Run the development server from the root directory:

First time:

npm i
npm run dev

Otherwise:

npm run dev

Then, open http://localhost:3000 with your browser to see a page with all of the components on it.

Using Our Components

The code for all of our components is in src/components.

Linter/Prettier

These commands will run the formatter (prettier) and linter (ESLint) for the whole respository:

  • yarn run lint - runs ESLint and reports all linting errors without fixing them
  • yarn run lint:fix - runs ESLint and reports all linting errors, attempting to fix any auto-fixable ones
  • yarn run format - runs Prettier and automatically formats the entire codebase
  • yarn run format:check - runs Prettier and reports formatting errors without fixing them