Grunnmuren - OBOS' design system

This is the monorepo for Grunnmuren, OBOS' design system.

⚠️ This branch is v2 of the design system, which is in active development and released with a canary tag. Expect frequent changes and breakage.

If you are looking for v1 of the design system, see the v1 branch.

Getting started

See these links:

• Documentation
• Storybook
• Figma

and check out these packages:

• @obosbbl/grunnmuren-react - The React component library.
• @obosbbl/grunnmuren-tailwind - The Tailwind preset for the design system.
• @obosbbl/grunnmuren-icons-react - SVG icons as React components.
• @obosbbl/grunnmuren-icons-svg - SVG icons.

and the documentation source:

• Docs

Contributing

Local setup

Install pnpm

This repository uses pnpm instead of npm. Follow their installation guide to set it up.

Install dependencies

pnpm install

Linting

The following command runs Biome.

pnpm lint

Build

To build all packages, run the following command:

pnpm build

Development

Note that before running the Storybook or docs app for the first time, you need to build the packages first. We currently don't use tools such as Turborepo or Nx.

Runs the storybook for local development, at http://localhost:6006.

pnpm dev

Runs the docs app for local development, at http://localhost:3000.

pnpm dev:docs

Releases and changelogs

We use an automated release process based on changesets and Github actions to version, release and publish the packages. Meaningful changes should be documented by running pnpm changeset and be a part of the pull request. Remember to follow semver.