@freshworks/dew-components

This repo contains the common React components for the Freshworks Dew 2.0 Design System

Dependencies

Dev Dependencies

📋 Overview

This package provides the foundational React components for the Freshworks Dew 2.0 Design System, including buttons, inputs, and other UI elements. These components are designed to be reusable and customizable, ensuring a consistent look and feel across applications.

🚀 Getting Started

📖 Full installation guide — registry setup, stylesheet imports, theming, and troubleshooting: docs/GETTING_STARTED.md

Installation

pnpm add @freshworks/dew-components

or

npm install @freshworks/dew-components

or

yarn add @freshworks/dew-components

🔧 Development Commands

| Command | Description | | -------------------------- | ------------------------ | | nx build dew-components | Build the library | | nx lint dew-components | Lint the library files | | nx format dew-components | Format the library files |

📚 Contents

Components

• Browse all DEW components in Storybook: https://dew.freshworkscorp.com/dew-3.0/

Build

Run nx build dew-components to build the library.

Running unit tests

Run nx test dew-components to execute the unit tests via Vitest. Run pnpm test:unit:ci to run unit tests in CI mode and generate coverage.

📝 Publishing

https://nx.dev/recipes/nx-release/automate-github-releases

To publish this package to the GitHub package registry:

1. Ensure you have the GitHub Personal Access Token set up in your .zshrc file:

   export GITHUB_TOKEN="xxx" or
   export GH_TOKEN="xxx"

   Note: This token needs write access to the repository.

2. Run the release command in dry-run mode to check for any issues:

   npx nx release --projects=dew-components --dry-run

   This will simulate the release process without actually publishing anything.

   View the sample output from the dry-run command : here

3. If everything looks good, run the release command to publish the package:

   npx nx release --projects=dew-components

4. After the release, verify the published package on GitHub Packages https://github.com/freshworks/fw-dew/pkgs/npm/dew-components