Hacking
If you would like to help out in developing this project and aren't sure where to start, reach out to Ricky on Discord.
Here are some tips to get started.
Setting up a dev environment
After cloning the repository, the following commands will install dependencies for the project and run the automated tests. They should all be run from the top level of the repository.
npm install
to install dependencies.npm run build
to build all of the packages.
Manual testing
There is a test site to run the VAD with different parameters for manual testing purposes. It is in fact deployed at test.vad.ricky0123.com. You can run it locally by running npm run dev
. When you open a PR, Vercel should deploy a preview version of the test site so that reviewers can test your changes.
Quick notes about playing with the VAD model interactively in the browser console
Go to test.vad.ricky0123.com and open the browser console. Then run the following line by line: