Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Poetry setup in readme #61

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Poetry setup in readme #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Poetry](https://python-poetry.org/)
- [Poetry](https://python-poetry.org/)
- NodeJS and Yarn 1.x

- Git (Obviously)

On MacOS:
Expand All @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Run `poetry install` in the root directory to install them.
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

Expand Down
Loading