@statisticsnorway/dapla-lineage-viewer NPM

dapla-lineage-viewer

This application is built for in-house use in Statistics Norway and it aims to create a smart and interactive lineage viewer for variables and datasets with the help of the graphql-api exposed by Linked Data Store.

Functionality includes:

Showing connections between variables and datasets (which datasets use which variables and vice versa) in a graph view

The project makes limited use of the ssb-component-library and is based upon react-reference-app.

Use as a library

If you want to use this application as a library in your project, simply add it with yarn.

yarn add @statisticsnorway/dapla-lineage-viewer

The component requires a few peer dependencies to work, namely:

@statisticsnorway/dapla-js-utilities
axios-hooks
color-hash
d3
d3-shape
graphql-hooks
React
react-d3-graph
SemanticUI

In your application import the component.

import { LineageViewer } from '@statisticsnorway/dapla-lineage-viewer'

The component needs two properties to function correctly, restApi and language.

<LineageViewer restApi='http://localhost:8080' language='en' />

restApi is the base url for any Linked Data Store you wish to use and language sets the language of the component. en (English) and nb (Norwegian) is available.

In your application housing this component you also need to set up graphql-hooks in a React Context. You can checkout how to do it in /src/utilities/ContextHandling.js in this project. This is done because the component needs several instances of graphql-hooks to run, and without setting up a GraphQLClient that, is impossible.

Try this application locally

The first time you clone the repository, remember to run yarn or yarn install.

Run yarn start and navigate to http://localhost:3000/.

yarn test runs all tests and yarn coverage calculates (rather unreliably) test coverage.

Docker locally

yarn build
docker build -t dapla-lineage-viewer .
docker run -p 8000:8180 dapla-lineage-viewer:latest
- Alternatively with custom environment variables: docker run -p 8000:8180 -e REACT_APP_API=http://localhost:29090 dapla-lineage-viewer:latest
Navigate to http://localhost:8000

Note that this application requires dapla-project (localstack) running to function locally (or at least a running instance of Linked Data Store).

Publish library

To publish to npm you need a user and a membership in the statisticsnorway organization on npm. The user must also have 2FA authentication enabled. Steps to follow:

Login into your npm account in a terminal with npm login
Make sure all tests works (test components in the example application as well, if you made a new one)
Bump version in package.json
Run yarn package
Dry run a release with npm pack
Publish with npm publish --access public --otp=<code> (<code> is your 2FA code, without <>)