UIKit

UI toolkit monorepo containing a React component library, UI utilities, a generative AI LLM parser, an AWS AppSync fetch utility, and more

Packages

| NPM Package Name | Version | Description | |------------------------------| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | [@acusti/input-text][] | | A promise-based node.js function for making AWS AppSync API graphql requests | | [@acusti/input-text-2][] | | An isomorphic module implementing the [AWS Signature V4 (SigV4) signing process][aws sigv4] for requests |

The React components are documented and illustrated in the storybook instance, which is located at packages/docs/ in the repository.

Tests

The monorepo uses vitest to run its tests. To run tests across all packages, use yarn test. To run them in watch mode, use yarn test:watch.

Building and Publishing

To build all packages, run yarn build. This will trigger tsc --build and yarn flowgen for all packages.

To build the storybook docs, run yarn build:stories, which will run yarn build and then the default storybook build command.

To publish all packages, manually update each packages’s version field in their package.json. If any of the packages depends on any of the other packages being updated, be sure to update the dependency version as well. Then run yarn publish. Publishing will trigger a build before running npm publish to ensure that the latest changes are published. To publish only a single package, use yarn workspace <package-name> npm publish --access public (e.g. yarn workspace @acusti/css-value-input npm publish --access public), but note that in that case, you are responsible for running yarn build yourself before triggering the publish.

After publishing the packages, run yarn to update the yarn.lock file and then commit the version updates with a message in the form of: :arrow_up: Bump package versions to _._._.

Developing

The two main run scripts for developing are yarn dev:watch, which kicks off the TypeScript compiler in --watch mode, and yarn dev:stories, which kicks off the default storybook command from packages/docs/. To run both of those in a single terminal window, use yarn dev.