Skip to content

Internal collection of components to standardize our designs

License

Notifications You must be signed in to change notification settings

GTBitsOfGood/design-system

Repository files navigation

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:

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

About

Internal collection of components to standardize our designs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published