Skip to content

Commit

Permalink
Update README.md (#207)
Browse files Browse the repository at this point in the history
  • Loading branch information
petertheprocess authored May 24, 2024
1 parent b8903b4 commit 70db421
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ The motivation behind a KAEPS is to provide a fun, interactive, and lighthearted
## Technologies

* [React](https://react.dev/) - Frontend JavaScript library developed by facebook
* [STOMP](https://stomp-js.github.io/stomp-websocket/) - Text agreement for configuring WebSocket connections
* [STOMP](https://stomp-js.github.io/stomp-websocket/) - Text oriented protocol over WebSocket
* [SockJS](https://github.com/sockjs) - API compatible with WebSocket
* [NPM](https://www.npmjs.com/) - Build automation tool
* [FFmpeg](https://ffmpeg.org/) - Open-source tool to record and convert audio
* [FFmpeg.wasm](https://ffmpegwasm.netlify.app/docs/overview) - A pure WebAssembly / JavaScript port of FFmpeg enabling powerful and blazing fast audio processing.
* [wavesurfer](https://wavesurfer.xyz/) - Audio visualization library for creating interactive, customizable waveforms.
* [reactour](https://docs.react.tours/) - Interactive tourist guide library.

<a name="high-level-components"></a>
## High level components
Expand Down Expand Up @@ -78,6 +80,10 @@ Notice that the page will reload if you make any edits. You will also see any li
The client will send HTTP requests to the server which can be found [here](https://github.com/HASEL-UZH/sopra-fs24-template-server).\
In order for these requests to work, you need to install and start the server as well.

```npm run lint```

Automatically check an format your code following predefined ESlint rules.

### Testing
Testing is optional, and you can run the tests with `npm run test`\
This launches the test runner in an interactive watch mode.\
Expand Down

0 comments on commit 70db421

Please sign in to comment.