WebStudio/README.md

# WebStudio

WebStudio is URY's big fun machine for doing radio shows from home, using Web Audio and WebRTC.

The clientside is written in TypeScript using React and Redux, the serverside is Python using AsyncIO and JACK.

## Development

### Requirements

Client:

 * Node.js and Yarn (Yarn 1, 2 isn't supported very well by webpack/typescript/anything really)

Server:

* Python >=3.7

### Installing

Clone the repo and run `yarn`.

You'll probably want to change the values in `.env` to reflect the MyRadio environment and/or where the server is running (e.g. if you're running the server locally, change `REACT_APP_WS_URL` to `ws://localhost:8079/stream`).

If you want to hack on the server, create a virtualenv and install Python packages:

```sh
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
```

### Hacking

Start the client by running `yarn 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

Every push to `master` is deployed automatically by Jenkins to https://ury.org.uk/webstudio-dev.

Deploying to https://ury.org.uk/webstudio is also automated but slightly more involved:

1. Change the `version` field in `package.json` to ensure the "about" page is up to date
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`)

## 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")
Instructions good 2020-04-11 10:25:57 +00:00			`# WebStudio`
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			`WebStudio is URY's big fun machine for doing radio shows from home, using Web Audio and WebRTC.`
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			`The clientside is written in TypeScript using React and Redux, the serverside is Python using AsyncIO and JACK.`
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			`## Development`
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
update README 2020-04-11 10:27:44 +00:00			`### Requirements`

			`Client:`

			`* Node.js and Yarn (Yarn 1, 2 isn't supported very well by webpack/typescript/anything really)`

			`Server:`

			`* Python >=3.7`

Instructions good 2020-04-11 10:25:57 +00:00			`### Installing`
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			Clone the repo and run `yarn`.
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			You'll probably want to change the values in `.env` to reflect the MyRadio environment and/or where the server is running (e.g. if you're running the server locally, change `REACT_APP_WS_URL` to `ws://localhost:8079/stream`).
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			`If you want to hack on the server, create a virtualenv and install Python packages:`
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			```sh
			`$ python3 -m venv venv`
			`$ source venv/bin/activate`
			`$ pip install -r requirements.txt`
			```
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			`### Hacking`
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			Start the client by running `yarn start`.
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Update README.md 2020-05-14 18:14:59 +00:00			Start the server by running `python3 stateserver.py` and `python3 shittyserver.py`.
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			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.
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			`## Releasing a new version`
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			Every push to `master` is deployed automatically by Jenkins to https://ury.org.uk/webstudio-dev.
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			`Deploying to https://ury.org.uk/webstudio is also automated but slightly more involved:`
Initial commit from Create React App 2019-11-12 12:21:05 +00:00
Instructions good 2020-04-11 10:25:57 +00:00			1. Change the `version` field in `package.json` to ensure the "about" page is up to date
			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`)
Added images to readme file 2020-07-10 23:45:23 +00:00
Changed level of screenshot 2020-07-10 23:49:14 +00:00			`## Screenshots`
Added images to readme file 2020-07-10 23:45:23 +00:00			`![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")`