The SmartCompanion Audioguide App is a free and open-source Progressive Web App (PWA) that delivers interactive audioguide experiences for museums and cultural institutions. It runs seamlessly in any modern mobile browser — no installation required.
The app is fully customizable, allowing you to adapt content, colors, text, and images to fit your institution’s needs. It also includes offline functionality powered by a service worker, ensuring smooth use even without an internet connection.
| Castle Tratzberg | Museum Landeck | Example App |
|---|---|---|
 |
 |
 |
- Fork and clone the repo
- Install all dependencies with
npm install - Either build the project with
npm buildor open a live preview within the browser withnpm start
| Service | Description |
|---|---|
| Netlify | The Example App is hosted on Netlify. Netlify offers a free option and supports custom domain. |
| Github Pages | Github Pages offers a free option for open source repositories and supports custom domains. |
| SmartCompanion | We offer a hosting service including a content management system, continous updates and security fixes, custom domains and support. |
The content is loaded from a data.json file, which contains all texts and references to assets like images and audio files. Inside the stencil.config.ts the DATA_URL should point to your data.json file. The sample data, which is used for the demo of the app can be found here. Custom data needs to be structured according to the example.
- scss color variables in
src/global/app.scss - background_color and theme_color in
manifest.json - theme_color in
index.html
- title and description in
index.html - title in
stencil.config.ts
logo.pnginassetsfolderfavicon.icoandicon.pnginassets/iconfolder
The PWA can be used with offline support with a service worker. When using a service work the initial startup of the app takes a bit longer, since all relevant files need to be downloaded and cached. Inside the stencil.config.ts file OFFLINE_SUPPORT can be set to true or false.
The SmartCompanion Audioguide App is licensed under the terms of the BSD 2-Clause license. Check the LICENSE text for further details.