Skip to content

BUILD.md

Latest commit

 

History

History
87 lines (59 loc) · 2.04 KB

BUILD.md

File metadata and controls

87 lines (59 loc) · 2.04 KB

Build & Run Guide

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.

1. Prerequisites

  • Node.js 18+ and npm 10+
  • For the documentation site: Python 3.9+ with pip

2. Install Dependencies

npm install

This installs all workspace packages, including the demo app dependencies.

3. Build the Library

npm run build
  • Runs microbundle-crl to build the component library
  • Outputs the distributable package under dist/
  • Add npm run start to watch for changes during development

4. Run Quality Gates

  • Unit tests: npm run test
  • Linting: npm run lint

These should be clean before submitting changes or publishing.

5. Run the Demo Application

The demo showcases three interactive examples:

  1. Address Form – Complete address collection workflow
  2. Events Showcase – Real-time event logger with all 14 events
  3. Playground – Test all configuration options

Steps:

  1. Update the API key in example/src/config.js. The checked-in key is for demos only and may be throttled.
  2. Start the dev server: 
    cd example
npm install
npm start      # serves the demo on http://localhost:3000
  3. The demo watches both the library and app; rebuilding the library will refresh the demo automatically.

6. Preview / Build the Documentation Site

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

7. Publishing

Library

  1. Ensure npm run build output is up to date
  2. Update version in package.json if needed
  3. From the repo root: 
    npm publish --access public