Welcome to the @lapidist/garnet monorepo, the hub for the Garnet Design System. This repository is organised into various packages and applications to streamline development, documentation, and maintenance.
Explore and interact with our design system components using Storybook.
npm run storybook
The public documentation website built with Next.js.
npm run dev
Our custom ESLint configuration for maintaining code quality.
{
"extends": "@lapidist/garnet"
}
The React implementation of the Garnet Design System, including components, hooks, and helpers.
npm install @lapidist/garnet-react
import { App } from '@lapidist/garnet-react';
import '@lapidist/garnet-react/style.css';
export default function Root() {
return <App>Hello world!</App>;
}
CSS modules defining the styles for our design system components.
Design tokens generated with style-dictionary.
Shared TypeScript types, including props for components.
Command | Description |
---|---|
npm run build |
Build projects with Lerna and Nx to ensure correct dependencies and build order. |
npm run lint |
Run ESLint for code style, syntax, and issue identification, enforcing coding standards. |
npm run fix |
Automatically fix common linting issues using ESLint's auto-fixing capabilities. |
npm run watch |
Continuously monitor projects for changes, triggering recompilation when necessary. |
npm run snapshots |
Update and regenerate snapshot tests. |
npm run typecheck |
Execute TypeScript type checker to catch type-related issues. |
npm run commit |
Create a new commit with Commitizen. |