Skip to content

AustralianBioCommons/gen3-dd-viz

Repository files navigation

gdc.svg

Gen3 Data Dictionary Visualizer

A lightweight, standalone visualizer for bundled Gen3 data dictionaries.

What’s inside

  • @gen3/dd-parser — TS library that normalizes a compiled Gen3 dictionary into a simple graph model.
  • @gen3/dd-viz — React component that renders the graph into SVG.
  • dd-viz-app — zero-backend Vite app: drag & drop your JSON or load via path.

Node 18+ recommended.

Quick start

# at repo root
npm install

# build all packages + app
npm run build

# run the app
npm run dev

Open the URL shown by Vite (default is http://localhost:5173).

Workspace scripts

  • npm run dev — launches apps/dd-viz-app in dev mode
  • npm run build — builds parser, viz, and the app
  • npm run typecheck — type checks packages and app

Notes

  • Layout is rendered to SVG for export.
  • Modern evergreen browsers only.

Testing

Run unit tests:

npm run -w @gen3/dd-parser test
npm run -w @gen3/dd-viz test

Example Dictionaries

This repository includes example Gen3 dictionary JSON files in examples/:

These can be used to test the parser or to explore the visualization without needing to source your own schema.

About

Visualizer for Gen3 data dictionary

Resources

License

Stars

Watchers

Forks

Packages

No packages published