Macrostrat web components

Web-Components is a React based user interface ecosystem designed for efficiently developing data-dense web-frontends. Foundationally built upon other UI-Libraries, heavily upon @blueprintjs, the components herein are meant to be easily implemented with much of the business logic encapsulated within the library itself.

Architecture

Libraries

Macrostrat's web components system is a workbench for producing user interface components. It is structured as a monorepo, with several modules (in the packages directory) that are being maintained for publication to NPM and referencing in Macrostrat's user-facing applications. Open-source contributions and third-party usage are welcome!

Several of the most important modules are:

• @macrostrat/ui-components
• @macrostrat/form-components
• @macrostrat/data-components
• @macrostrat/column-components

Contributing to web components

Installation

To get started developing Macrostrat web components, clone this repository to your machine and run

git submodule init --recursive

This will automatically initialize all git submodules used in the monorepo.

Next install all necessary modules. The repository is set up to use Yarn v2 by default, for quick installs and updates.

yarn

Storybook

We use Storybook for developing components in an isolated environment. To start the storybook, run yarn run dev in the root directory.

The storybook will start at port 6006

Publishing packages

This monorepo has a custom script that helps with publishing packages.

• Run yarn run status to view a change list for each potential package to be published. This will allow you to update package.json versions and changelog entries.
• If desired, you can run yarn run prepare to try building the packages.
• If the build is successful, you can run yarn run publish to publish new versions.

You will need the NPM organizational credentials (to the @macrostrat organization) to publish packages.