kirangadhave/trrackjs

A library for history/provenance tracking in web-based visualizations.

Trrack

Trrack stands for reproducible tracking. Originally Trrack is a web-based provenance tracking library that can track application state in directed provenance graph.

This branch implements action based provenance tracking.

Development

Clone the repository and switch to trrack-action branch. This project was generated using Nx. Please refer to Nx for more any questions about monorepo setup.

Basic

Serve the react example by running the following:

npx nx react-trrack-example:serve

Any changes made to the core package will cause updates to the react example for easier testing

Advanced

To get started with development run:

yarn install # Trrack can also work with npm, but it uses workspaces feature which we have only tested with yarn.

yarn dev:all # Will run all examples

yarn test:all:watch # Will run tests for all trrack pacakges in watch mode

The repository is structured as follows:

trrack-monorepo
|
|--- pacakges # trrack library is located in this folder
    |--- core # Core action-based tracking library
    |--- redux # Redux toolkit wrapper for core
|
|--- apps # Trrack examples are located in this folder
    |--- react-trrack-example
    |--- rtk-trrack-example

Following the standards for Nx monorepos please install any dependency for the applications directly to root workspace. This ensures all the applications use same versions of any dependency. For the packages, install the dependency to appropriate package.