Skip to content

Commit

Permalink
Merge pull request #61 from UniversityRadioYork/poetry-readme
Browse files Browse the repository at this point in the history
Poetry setup in readme
  • Loading branch information
ColinRoitt authored Oct 4, 2024
2 parents 9664f09 + c254e69 commit c6e8c52
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ 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/)
- NodeJS and Yarn 1.x
- Git (Obviously)

On MacOS:
Expand All @@ -47,7 +49,10 @@ 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.
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.

Make sure to add your API key into the config page once its running.

Expand Down

0 comments on commit c6e8c52

Please sign in to comment.