@therms/atalaya

@therms/atalaya

React components and style guide for THERMS.

Install

Git master branch, the latest production/stable release, docs: @therms/atalaya

npm i @therms/atalaya

Git next branch, the next major stable release in development and testing, docs: @therms/atalaya@next

npm i @therms/atalaya@next

Development and features on the next branch is primarily for breaking changes (major release version change). This branch/tag should be considered mostly stable and typically published along side of a lower @latest major release in order to give packages time to migrate from a previous version.

Git x.x.x-beta.x branch, development effort release, docs: @therms/atalaya@beta

npm i @therms/atalaya@beta

Development, refactoring, additions, improvements, etc. are done on the beta branch.

Docs

This project uses Styleguidist for documenting components. Components are automatically documented and can additionally have [component name].md files to add additional documentation.

Running the docs:

npm run docs

Building the docs:

npm run docs:build

Development

This project uses Storybook for developing components with quick UI feedback/reloading on the developers local machine. Run npm run storybook.

To run this project and develop components that are used by another project locally on the same machine, we have created a custom script that requires developer input to work. npm link would typically work except there is some node_modules resolution issues w/ symlinks and resolving dependencies from the correct node_modules dir. You will provide the root project directory where you want Atalaya to be bundled and updated to while you are developing components and expecting to see them updated in the consuming project.

Run:

npm run build:dev -- --project ../wallboard

The cmd npm run build:dev starts rollup in watch mode and the -- is required to pass additional cmd line args to the process. --project ../wallboard is the relative path to the project directory that you want to actively develop in while changing Atalaya components.

This process is a little slow because every change triggers a new bundle to be built

Known Issues

• Webpack: Storybook requires webpack4 to work. Styleguidist requires webpack5.
• Postcss: Postcss8 is required for tailwind, Storybook isn't compat, yet.
• Styleguidist: Documenting component props is a PITA.