Go to file
Harrison Deng 1efd0f4588
All checks were successful
audioshowkit/pipeline/head This commit looks good
Switched over to to dedicated NodeJS container build environment
2024-11-14 03:36:48 +00:00
.devcontainer Switched over to to dedicated NodeJS container build environment 2024-11-14 03:36:48 +00:00
.vscode Added font size mapping demo. 2022-04-23 00:10:09 -05:00
src Added explicit "null" return to function. 2022-11-25 16:09:04 +00:00
tests Added a test for the new bin utilities module. 2022-04-23 01:16:56 -05:00
tutorials Tutorial title tag sizes decreased. 2022-04-23 08:57:34 -05:00
.eslintignore Refactored repo file structure in preparation for jsdoc tutorials. 2022-04-18 07:39:59 -05:00
.eslintrc.json Fixed linear easing function. 2022-04-18 15:11:42 -05:00
.gitignore Untracked built audioshowkit from tutorial asset. 2022-04-18 12:10:21 -05:00
babel.config.json Refactored repo file structure in preparation for jsdoc tutorials. 2022-04-18 07:39:59 -05:00
environment.yml Added devcontainer configurations and updated pipeline. 2024-07-22 02:48:20 +00:00
Jenkinsfile Switched over to to dedicated NodeJS container build environment 2024-11-14 03:36:48 +00:00
jsdoc.config.json Set up JSDoc tutorial system and dev environment. 2022-04-18 08:05:41 -05:00
notes.md Refactored repo file structure in preparation for jsdoc tutorials. 2022-04-18 07:39:59 -05:00
package.json Updated some dependencies. 2022-11-25 16:20:21 +00:00
README.md Updated README.md to direct to the correct link. 2022-11-30 04:04:50 +00:00
webpack.common.cjs Refactored repo file structure in preparation for jsdoc tutorials. 2022-04-18 07:39:59 -05:00
webpack.dev.cjs Demos for music player and music playlist functional. 2022-04-18 11:46:23 -05:00
webpack.prod.cjs Refactored repo file structure in preparation for jsdoc tutorials. 2022-04-18 07:39:59 -05:00

AudioShowKit

A library that makes visualizing audio data live a much simpler process.

Getting Started

As this library has not been published as a package, the best way to use it is to go to download the latest successful build artifact which can be found here. This build artifact is a minified and bundled version of all the components in the library.

From here, add the downloaded javascript bundle to your html as you would any other javascript file:

<script src="./audioshowkit.js" defer></script>

Now, any script that is loaded after the audioshowkit.js script loads will have access to the audioshowkit object. Prepared are three tutorials with demonstrations. I recommend starting with the Music Playlist tutorial.

Resources

The documentation along with latest stable build can be found here. The documentation is accessible to on the left bar and the build artifact can be downloaded as a zip.