Iron Health PrimeReact Theme
This package was bootstrapped using the React Storybook boilerplate: https://storybook.js.org/tutorials/intro-to-storybook/react/en/get-started/
It contains a custom Prime React theme for Iron Health's applications with an importable component library.
Commands
Storybook
These commands allow you to run and develop React Components with storybook. While this repo's focus is a PrimeReact theme, we demo common PrimeReact components to illustrate overall styling.
Commands:
-
$ npm i
to install all the packages in the root of this folder -
$ npm run storybook
which will launch an interactive dashboard
NPM Actions
./github/workflows/build-npm.yml
)
Configuring the workflow to publish npm (The NPM Publishing workflow simply requires a NPM_TOKEN environment variable, to generate one:
- Login to https://npm.js.com
- Go to settings and select Access Tokens
- Click generate new Classic Token with an automation type
- Set that token as a variable, https://github.com/Iron-Health/ironhealth/settings/secrets/actions in wth the name
NODE_AUTH_TOKEN
NPM Publish
To add or update a package, run the following:
- First, login to NPM:
$ npm login
- Run
$ npm publish --access public
Incrementing the version
To increment the version, simply run $ npm version xyz
.
NPM Unpublish
To unpublish and remove a package, run the following:
- First, login to NPM:
$ npm login
- Run
$ npm unpublish @ironhealth.io/pr-theme@0.0.1 --force
Theme implementation
PrimeReact Theme
In your target application, simply run the following commands:
npm install -D @ironhealth/pr-theme@latest"
- Add
@import "@ironhealth.io/pr-theme/main.scss"
at the top of your scss
React Components
In your target application, simply run the following commands:
npm install -D @ironhealth/pr-theme@latest"
- Add
import { Nav } from "@ironhealth/pr-theme
at the top of your javascript file