diff --git a/README.md b/README.md index 3ce9de3..b3d1e26 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # ShowManager [![Build Status](https://github.com/MrExplode/ShowManager/actions/workflows/build.yml/badge.svg)](https://github.com/MrExplode/ShowManager/actions) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/06b58e31d1834512bc7016d8240cb6f8)](https://www.codacy.com/gh/MrExplode/ShowManager/dashboard?utm_source=github.com&utm_medium=referral&utm_content=MrExplode/ShowManager&utm_campaign=Badge_Grade) [![Codecov](https://img.shields.io/codecov/c/github/MrExplode/ShowManager)](https://app.codecov.io/gh/MrExplode/ShowManager) This project aims to be the "brain" of a prerecorded show by playing Art-Net timecode, sending scheduled OSC messages and playing audio tracks synced to timecode. + + ## About Please note that this is a hobby project of mine, and it is WIP. Only `wav` files are supported. Some options can be only changed from the configuration file, notably - Audio output @@ -24,20 +26,25 @@ You can build the Java artifact with: ``` the artifact will be in `build/libs` -### ShowManager-Frontend -ShowManager uses a [web UI](https://github.com/MrExplode/SM-Frontend). Currently you have to build it separately and tell it's location to ShowManager. -The frontend is built with `npm`, obviously you have to install it first. - -Setting up the repo: -```shell -npm install +### UI +ShowManager uses a [web UI](webapp). In order to use you have to build it first, using standard [web tooling](https://pnpm.io). + +```bash +# First setup +pnpm install ``` - -Building the project: -```shell -npm build +```bash +pnpm run build ``` -Set the `dist` folder's path to the environment value `showmanager.dist` + +After setting up the project with `pnpm install`, you can use the `build-webapp` gradle task for building. It runs the pnpm +build command internally. +```bash +# example full clean build, without tests +./gradlew clean build build-webapp -x test +``` + +Set the `build` folder's path to the environment value `showmanager.dist` # Usage Run the java artifact with: @@ -82,3 +89,5 @@ You have to set the audio output, and add your tracks. Example: } ``` +Run again, and open the web UI on the host+port that's specified in the project settings. It defaults to `http://127.0.0.1:7000`. + diff --git a/docs/ui_1.png b/docs/ui_1.png new file mode 100644 index 0000000..3deba75 Binary files /dev/null and b/docs/ui_1.png differ