Repository files navigation

Web client forüWave.

Dependencies -Setup -Building -API -License

For running in the browser: something modern. The aim is to support ~IE11+ andother modern browsers (recent Chromes and Firefoxes, at least). If you usesomething reasonably recent and üWave doesn't work,file a bug!

The server parts of üWave require Node version >= 18.18.0.

To run the web client, you need anüWave server to connect to.For development, first install the server:

git clone https://github.com/u-wave/core u-wave-corecd u-wave-corenpm installnpm start

npm start will run the üWave server on port 6042.

Then in a separate terminal do:

git clone https://github.com/u-wave/web u-wave-webcd u-wave-webnpm installnpm run dev

This will run the web client on port 6041. Visithttp://localhost:6041 to useit!

There are two main build scripts: one for development, and one for production.

The development script runs a local üWave server and auto-reloads the web clientwhen you make changes.

npm run dev

When building the üWave web client for use on a server, the production buildshould be used instead. It removes costly debugging helpers from the code andminifies everything as much as possible.

npm run prod

Theprod script doesn't run a local server. To try out your production build,you can use the standaloneserve script:

npm run serve

Please see the README in thecompiled npm package for API documentation.

The üWave web client is licensed under theMIT license.

The defaultmention sound file comes from aSonics.io pack and is undertheSonics.io License (archive link).