https://github.com/smartcompanion-app/smartcompanion-library
SmartCompanion library to build apps
https://github.com/smartcompanion-app/smartcompanion-library
stenciljs storybook web-components
Last synced: 2 months ago
JSON representation
SmartCompanion library to build apps
- Host: GitHub
- URL: https://github.com/smartcompanion-app/smartcompanion-library
- Owner: smartcompanion-app
- License: bsd-2-clause
- Created: 2025-06-01T13:02:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-06T17:13:12.000Z (8 months ago)
- Last Synced: 2025-10-06T19:13:35.476Z (8 months ago)
- Topics: stenciljs, storybook, web-components
- Language: TypeScript
- Homepage:
- Size: 4.59 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SmartCompanion Library
[](https://github.com/smartcompanion-app/smartcompanion-library/actions/workflows/ci.yml)
[](https://smartcompanion-app.github.io/smartcompanion-library/)
## Table of Contents
- [Packages](#packages)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Local Development](#local-development)
- [License](#license)
- [Links](#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
```bash
npm install # Install all workspace dependencies
npm run build # Build all packages
npm test # Run tests for all packages
```
## Local Development
### @smartcompanion/data
```bash
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
```bash
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](https://storybook.js.org/).
```bash
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
```
### apps/audioguide-app
The `apps/audioguide-app` workspace is a consumer application included in this monorepo. It is built on top of the packages above.
## License
The SmartCompanion Library Packages are licensed under the terms of the BSD 2-Clause license. Check the [LICENSE](LICENSE) text for further details.
## Links
- [Web site](https://www.smartcompanion.app)
- [Storybook](https://smartcompanion-app.github.io/smartcompanion-library/)
- [Native Audio Capacitor Plugin](https://github.com/smartcompanion-app/native-audio-player)