From eaa1c4d0d247f17cfb1cda92ca65a47f484f7351 Mon Sep 17 00:00:00 2001 From: Colin Roitt Date: Tue, 27 Aug 2024 16:37:45 +0100 Subject: [PATCH 1/3] add poetry instructions to readme --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f71303a..b6434cb 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ Starting and stopping the server, as well as UI links, are available in the Syst On all platforms: - Python 3.8 - 3.11 Tested +- [Poetry](https://python-poetry.org/) - Git (Obviously) On MacOS: @@ -47,7 +48,9 @@ On MacOS: ### Running -To just run the server standalone without installing, run `python ./launch.py`. +To run the server standalone without installing BAPSicle, you'll need to install the dependencies. +Run `poetry install` in the root directory to install them. +Then, run `poetry run python ./launch.py` to start the server. ## Building From 697fb2950d17f97f98039671ade6e8636e9001dd Mon Sep 17 00:00:00 2001 From: Colin <9614541+ColinRoitt@users.noreply.github.com> Date: Fri, 4 Oct 2024 18:14:35 +0100 Subject: [PATCH 2/3] Update README.md Co-authored-by: Ash --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b6434cb..f0f0619 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,7 @@ On all platforms: - Python 3.8 - 3.11 Tested - [Poetry](https://python-poetry.org/) +- NodeJS and Yarn 1.x - Git (Obviously) On MacOS: From c254e697654a38ddff8202c5ab38b909776c2155 Mon Sep 17 00:00:00 2001 From: Colin <9614541+ColinRoitt@users.noreply.github.com> Date: Fri, 4 Oct 2024 18:14:55 +0100 Subject: [PATCH 3/3] Update README.md Co-authored-by: Ash --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f0f0619..88d1ff0 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ On MacOS: To run the server standalone without installing BAPSicle, you'll need to install the dependencies. Run `poetry install` in the root directory to install them. +BAPSicle also requires a built version of the [presenter UI](https://github.com/UniversityRadioYork/WebStudio) in order to use; run `npm run presenter-make` to build it (the output will be in `presenter-ui`/). Then, run `poetry run python ./launch.py` to start the server. ## Building