0.2.0 • Published 3 years ago
@dynamic11/react-wet v0.2.0
WET-React UI components library
React implementation of the Web Experience Toolkit (WET).
:warning: This project is early stages of development. We are actively working hard to implement more components.
Build status
Storybook deployments
The Storybook build can be found here:
Core documentation
This react component library is implemented based on the WET frontend CSS framework and React Bootstrap.
The documentation for these core projects can be found here:
The purpose:
The purpose of this package is to "Reactify" the Web Experience Toolkit (WET). This will make it faster and easier to develope applications using WET. It also removes the JQuery dependency of WET.
This project has 3 main goals:
- :rocket: make it easier to create frontend apps
- :wheelchair: have accessible components (WCAG AA)
- :books: clean and accurate documentation (Storybook)
How to run locally:
- clone the repo to you local machine
- open terminal inside the project directory
- install packages using
npm install
- launch Storybook using
npm run storybook
- navigate to
http://localhost:6006
to see Storybook running based on you local code. As you save your changes, the storybook will automatically update.
Project scripts:
Here is what each script in the package.json
does:
test
: runs the component testslint
: runs ESlint to check for issueslint:fix
: runs ESlint to check for issues and auto fixes themprettier
: runs prettier to check for code styling issuesprettier:fix
: runs prettier to check for code styling issues and auto fixes themstorybook
: spins up a dev instance of Storybook that is based on the local changes. The running application can be found athttp://localhost:6006
build-storybook
: builds a static version of Storybook (not often needed)chromatic
: Deploy the current code to a chromatic image and provide a sharable linkprepare
: Enable Git hooks