Local development
Clone and install#
git clone https://github.com/Getsoren/design-system.git
cd design-system
yarn installYarn is the package manager used for local development of the library itself (consumers of the published package can use npm, bun, yarn, or pnpm — see installation).
Available scripts#
| Script | What it does |
|---|---|
yarn run dev |
Starts dev mode at http://localhost:5173 with hot reload. |
yarn run build |
Builds the library for production into dist, minified with hashed filenames. |
yarn run preview |
Locally previews the production build. |
The tech stack#
The local dev workflow is built on:
- React v18+ with Hooks
- Vite — Next Generation Frontend Tooling
- Yarn package manager
- ESLint code analyzer
- Vitest — Vite-native unit test framework
- React Testing Library — React DOM testing utilities
- Emotion CSS — writing CSS styles with JavaScript
- Husky — modern native git hooks
- Chromatic — visual testing regression
See tech stack for how these pieces fit together, or testing for how Vitest and React Testing Library are used.
What's next#
Once your local environment is running, Storybook is the fastest way to browse every component visually while you work.
