ash/WebStudio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add BAPSicle info to readme

Browse source
This commit is contained in:
Matthew Stratford 2021-09-08 00:38:11 +01:00
parent 25e0031c0a
commit 6d5d6d135d
1 changed files with 21 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,6 +1,6 @@
# WebStudio
WebStudio is URY's big fun machine for doing radio shows from home, using Web Audio and WebRTC.
WebStudio is URY's big fun machine for doing radio shows from home, using Web Audio and WebRTC. It's also now home to BAPS Presenter, for the BAPS3 [(BAPSicle)](https://github.com/UniversityRadioYork/BAPSicle) project, a stripped down WebStudio with most interactions syphoned off to the BAPSicle server instead.
The clientside is written in TypeScript using React and Redux, the serverside is Python using AsyncIO and JACK.
@ -30,15 +30,21 @@ $ source venv/bin/activate
$ pip install -r requirements.txt
```
### Hacking
### Versions
Start the client by running `yarn start`.
This project provides two different output versions. WebStudio (a client that does all audio in the browser) and BAPS Presenter (a client that controls / displays info from the BAPSicle server).
See below for how to work on each one.
### Hacking (WebStudio)
Start the client by running `npm start`.
Start the server by running `python3 stateserver.py` and `python3 shittyserver.py`.
Don't forget to ensure that both TypeScript and MyPy pass, as your code will be rejected by CI otherwise - run `tsc --noEmit` and/or `mypy server.py` to check.
## Releasing a new version
#### Releasing a new version
Every push to `master` is deployed automatically by Jenkins to https://ury.org.uk/webstudio-dev.
@ -48,9 +54,19 @@ Deploying to https://ury.org.uk/webstudio is also automated but slightly more in
2. Push up your version bump and create a pull request to the `production` branch - https://github.com/UniversityRadioYork/WebStudio/compare/production...master
3. Once your changes are merged into `production` they'll get deployed automatically (although you will need to restart the server - ssh to Dolby and run `sudo systemctl restart webstudioserver`)
### Hacking (BAPS Presenter)
Start the client by running `npm run start-baps`. If you're running non-default settings for your BAPSicle development server, please change `.env-baps-development`.
#### Releasing a new version
This is done via the BAPSicle project by updating the `/presenter` submodule, since BAPS Presenter is built and packaged into the BAPS Server releases there.
If you want to demo build a BAPS Presenter release, run `npm run build-baps` and the result will be in the `build` directory.
## Screenshots
![Mic Live With Main Screen](images/HomeWithMic.png?raw=true "Mic Live on Main Screen")
![Home Page of webstudio](images/Home.png?raw=true "Home Page of WebStudio")
![Mic Selection Screen](images/MicSelection.png?raw=true "Mic Selection Screen")
![Mic Selection Screen](images/MicSelection.png?raw=true "Mic Selection Screen")