PXA-DSL

Design System Library for Carter/Shyftlabs Dashboards with Storybook and Shadcn UI Library and Tailwind

Run/Build the application

• Install Dependencies & Initial Pre Commit Hooks (Note: We use yarn as a package manager so please install yarn before proceeding)

yarn
yarn run prepare
npx husky add .husky/pre-commit "yarn run husky"

• Run the development server:

yarn dev

• Run the Storybook server:

yarn storybook

Publishing to GitHub Packages (private)

This package is published privately to GitHub Packages as @shyftlabs/shyftlabs-dsl.

Consuming

Consumers must configure authentication in .npmrc:

@shyftlabs:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}

Install:

npm install @shyftlabs/shyftlabs-dsl
# or
yarn add @shyftlabs/shyftlabs-dsl

Publishing

Publishing is automated via GitHub Actions on tag push v*, release publish, push to develop/test, and merged PRs to develop/test.

Manual publish (requires GitHub token with packages:write):

npm publish --access=restricted --registry=https://npm.pkg.github.com