maia-gui

Classes for building MAIA GUIs supporting various applications by Music Artificial Intelligence Algorithms, Inc.

Developer

Running examples

The examples folder contains working examples, such as waveform sequencer (relatively simple) and piano_roll+env_sequencer (more complex). For each example, the most important file to study to see how to build interfaces with MAIA GUI is public -> sketch.js.

To run these examples locally,

1. You will need Node.js installed.
2. In Terminal or GitBASH, navigate to the directory containing the example (if you run the ls command, one of the files should be server.js)
3. Execute npm install to obtain the dependencies for your example of choice. (The dependencies are minimal -- just fastify and fastify-static to serve the page and associated resources.)
4. Execute node server.js from the command line, then point your browser at http://127.0.0.1:3000/

For the example piano_roll_plot, the provided MIDI file (public -> src -> midi -> 802.mid) must be converted into a Composition object before running server.js. The conversion script midi2comp_obj.js can be executed as follows:

node midi2comp_obj.js -u default

Generating docs from the source code

For documentation, execute jsdoc --configure .jsdoc.config.js es6 to update the documentation, which gets written to the docs folder, and check it looks good and reads well.

There is some helpful advice on documenting classes here.