@get-dx/d3-charts

@get-dx/d3-charts package

This repository contains our D3.js chart classes:

• BarChart
• BumpChart
• LineChart
• PieChart
• ScatterChart
• ScatterTimeChart
• StackedBarChart
• StackedAreaChart
• MultiLineChart

Install

npm install @get-dx/d3-charts # npm
yarn add @get-dx/d3-charts    # yarn
bun add @get-dx/d3-charts     # bun
pnpm add @get-dx/d3-charts    # pnpm

Development

To get started —

1. Enable corepack -

corepack enable
corepack prepare yarn@4.1.1 --activate

1. Setup yarn -

yarn

1. View chart examples -

bin/start

To test this package locally in another app, use yalc.

Before these steps, install yalc -

yarn dlx yalc

YALC Steps —

1. Setup yarn -

yarn

1. Build this package and publish —

yarn build && yarn dlx yalc publish

1. In the app where you want to test this package, add the package with yalc —

yarn dlx yalc add @get-dx/d3-charts

When you make changes to this package, run yarn build && yarn dlx yalc publish again, then in your app run yarn dlx yalc update @get-dx/d3-charts.

Publishing

To release a new version —

1. Ensure you've incremented the version in package.json according to semantic versioning standards
2. Merge your changes into main
3. Create a new release in Github to publish the new version.
   • Ensure your release has a new tag and name matching the version in package.json. i.e. v1.0.0.
   • Creating a release will kickoff a github action to publish to NPM.
4. View the new version in NPM - https://www.npmjs.com/package/@get-dx/d3-charts