Getting started with WebChucK development! NOTE: All development is done on the dev
branch. main
is reserved for releases.
Make sure you have Git and Node installed.
Clone the repository if you haven't already.
git clone https://github.com/ccrma/webchuck.git
In the webchuck repo, install npm dependencies
npm install
Build WebChucK by running:
npm run build
This will build WebChucK and place all necessary files in the ./dist
folder. Additionally, it will build ./src/wc-bundle
which is the bundled ESM module of WebChucK (essentially all of ./dist
) for local use.
After you've built WebChucK, serve this repository using your local server. Then open ./test/index.html
in your browser.
You can do this on your own or simply run
npm run test
Run the test bench in the browser, verifying tests pass and sound is made. To debug tests and print or write more tests, modify ./test/chuckTest.js
.
Run this to generate the latest WebChucK documentation using TypeDoc
npm run doc
View the documentation at ./docs/index.html