This repository contains the React component library, a demo app, and the MkDocs documentation site. Use this guide to set up a local workstation and verify changes before publishing.
- Node.js 20.19+ or 22.12+ and npm 10+
- For the documentation site: Python 3.9+ with
pip
npm installThis installs the library dependencies. The demo app has its own dependency tree under example/.
npm run build- Runs
microbundle-crlto build the component library - Outputs the distributable package under
dist/ - Add
npm run startto watch for changes during development
- Complete test pipeline:
npm test - Unit tests only:
npm run test:unit - Linting only:
npm run test:lint - Build only:
npm run build
These should be clean before submitting changes or publishing.
The demo showcases three interactive examples:
- Address Form – Complete address collection workflow
- Events Showcase – Real-time event logger with all 14 events
- Playground – Test all configuration options
- Update the API key in
example/src/config.js. The checked-in key is for demos only and may be throttled. - Start the dev server:
cd example npm install npm start # serves the demo on http://localhost:3000
- The demo links to the library in the parent directory. After changing the library source, run
npm run buildfrom the repository root; Vite will then reload the linked output.
The docs live under docs-site/ and use MkDocs Material.
cd docs-site
# Create virtual environment (first time only)
python3 -m venv venv
# Activate virtual environment
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Live preview at http://127.0.0.1:8000
mkdocs serve
# Or build static site into site/ directory
mkdocs build- Ensure
npm run buildoutput is up to date - Update version in
package.jsonif needed - From the repo root:
npm publish --access public