GV Tech Design System


A React component design system derived from the Storybook Design System. This repository provides a lightweight, opinionated set of UI components and tooling used by Garcia Ventures projects.

---

Table of Contents

- GV Tech Design System
- Demo
- Install
- Usage
- Development
- Testing
- Releases \& Publishing
- Contributing
- Roadmap
- License

---

Demo

Storybook static docs are available in this repository (stories + src): run locally with yarn storybook or view the compiled output if hosted.

Install

The public package is published as @gv-tech/design-system:

``bash


npm

npm install @gv-tech/design-system

yarn

yarn add @gv-tech/design-system
`

Usage

Example import:

`js
import { Button } from '@gv-tech/design-system';

function App() {
return Click me;
}
`

Development

Start a local dev server:

`bash
yarn dev
`

Available scripts (selected):

- yarn dev — start Vite dev server
- yarn build — build the package
- yarn storybook — run Storybook locally
- yarn test — run tests locally
- yarn test:ci — run tests in CI
- yarn lint — run eslint

For full commands and details see package.json.

Testing

Unit tests use Vitest and React Testing Library.

- Run tests locally: yarn test
- CI runs: yarn test:ci

Releases & Publishing

We use googleapis/release-please-action to create release PRs and tags. For details on how to set it up and test releases, see .github/RELEASING.md.

Publishing uses OIDC via npm Trusted Publishers for @gv-tech publishing.

Contributing

Please read the full guidelines in CONTRIBUTING.md before contributing. Key points:

- Follow Conventional Commits to ensure release tooling produces accurate changelogs.
- Run yarn lint and yarn test` before opening PRs.

Roadmap

See issues and milestones for planned work.

License

This project is licensed under the MIT License. See LICENSE for details.

---

> For README best practices, we follow guidance from