Commit 6243e87b authored by David Trattnig's avatar David Trattnig
Browse files

Doc: Info on prod build

parent fd8d5350
Pipeline #1891 failed
......@@ -61,15 +61,12 @@ Provided components:
2. [Install](#install)
3. [Run](#run)
5. [Production](#production)
1. [Link the bundle](#link-the-bundle)
2. [About](#about)
<!-- /TOC -->
## Website Integration
The player components can be integrated to your website with a few simple steps.
## Components
### Radio Player
......@@ -410,23 +407,15 @@ To build the components for production run
./run.sh build
```
Use the generated components in your own website.
### Link the bundle
Place the JS and CSS files in `trackservice/src/public/build` to the relevant directory of the web-server.
The resulting build artifacts are located in `public/build`.
Then include 'em in the template or some specific page of your Radio Stations's website:
Now include the bundle in your theme, template, dependency management system or however your website is organized:
```html
<head>
...
<script defer src='/build/aura-player-bundle.js'></script>
...
</head>
```
1. Copy the artifacts `aura-player-bundle.js` and `aura-player-bundle.css` to your website assets. For pre-defined Material Design styles also grab `smui.css` and `smui-dark.css`.
2. Instatiate required components, as described in the [Components](#Components) section above.
3. Style the components using CSS. You can use the provided demo `public/aura-player-theme.css` as a starter.
Now you can instantiate any component as outlined above in the [Components](#Components) section.
In the future we may provide explicit support NPM installation and for SvelteKit integration.
# About
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment