GV Tech Design System

A React component design system. This repository provides a lightweight, opinionated set of UI components and tooling used by Garcia Ventures projects, built with Nx, Vite, and TypeScript.

Table of Contents

• GV Tech Design System
  • Demo
  • Install
  • Usage
  • Development
  • Testing
  • Releases & Publishing
  • Contributing
  • Roadmap
  • Support
  • License

Demo

The design system includes a Vite-based playground site. Run it locally with bun run dev or view the hosted version on Cloudflare Pages.

Install

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

# npm
npm install @gv-tech/design-system

# bun
bun add @gv-tech/design-system

Usage

Example import:

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

function App() {
  return <Button>Click me</Button>;
}

Development

Start a local dev server:

bun run dev

Available scripts (selected):

• bun run dev — start Vite dev server (Playground site)
• bun run build — build the library and registry
• bun run build:site — build the playground site
• bun run test — run tests locally
• bun run test:ci — run tests in CI
• bun run lint — run eslint

For full commands and details see package.json.

Testing

Unit tests use Vitest and React Testing Library.

• Run tests locally: bun run test
• CI runs: bun run test:ci

Releases & Publishing

We use Nx Release to manage versioning and changelogs. Releases are triggered automatically every Sunday or manually via the Release GitHub Action.

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

Contributing

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

• Follow Conventional Commits to ensure release tooling produces accurate changelogs.
• Run bun run lint and bun run test before opening PRs.

Roadmap

See issues and milestones for planned work.

Support

If you find this project useful, consider supporting its development:

License

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

For README best practices, we follow guidance from https://www.makeareadme.com/