SmartCompanion Library

Table of Contents

• Packages
• Prerequisites
• Getting Started
• Local Development
• License
• Links

Packages

Package	Description
@smartcompanion/ui	Stencil v4 web components — image-slideshow, marquee, numpad, player-controls, station-icon
@smartcompanion/data	Domain models and data layer — assets, languages, pins, servers, stations, text, tours
@smartcompanion/services	Service layer — AudioPlayerService, MenuService, RoutingService

Getting Started

npm install        # Install all workspace dependencies
npm run build      # Build all packages
npm test           # Run tests for all packages

Local Development

@smartcompanion/data

npm run build -w packages/data    # Compile TypeScript to dist/
npm run test -w packages/data     # Run Vitest tests
npm run lint -w packages/data     # Lint source files
npm run format -w packages/data   # Format source files with Prettier

@smartcompanion/services

npm run build -w packages/services    # Compile TypeScript to dist/
npm run test -w packages/services     # Run Vitest tests
npm run lint -w packages/services     # Lint source files
npm run format -w packages/services   # Format source files with Prettier

@smartcompanion/ui

UI components are developed in isolation with Storybook.

npm run build -w packages/ui       # Compile Stencil components
npm run test -w packages/ui        # Run Vitest and Playwright browser tests
npm run watch -w packages/ui       # Stencil watch mode
npm run storybook -w packages/ui   # Dev server at http://localhost:6006

License

The SmartCompanion Library Packages are licensed under the terms of the BSD 2-Clause license. Check the LICENSE text for further details.

Links

• Web site
• Storybook
• SmartCompanion Audioguide App
• Native Audio Capacitor Plugin