Skip to content

grame-cncm/fausteditor

Repository files navigation

Faust Editor

The online Faust Editor can be used to edit, compile and run Faust code from any recent Web Browser with WebAssembly support. It works completely on the client side and it is therefore very convenient for situations with many simultaneous users (workshops, classrooms, etc.). It embeds the latest version of the Faust compiler with an efficient webassembly backend and offers polyphonic MIDI support.

Features

The editor engine is based on CodeMirror. It provides syntax highlighting, auto completion and direct access to the online documentation. The documentation command (ctrl-d) uses the function name at the cursor position to locate to the relevant information.

Recommended Browsers

The recommended browsers are the latest versions of Firefox and Chrome.

Useful links

Development

Notes

We use Vite for development mode and builds. Dependencies include CodeMirror for providing an editor, FaustWasm for compiling Faust client-side, and FaustUI for rendering widgets.

Setup

Clone and enter the repository, then run:

npm install

Run in development mode (automatic reloading)

npm run dev

Then press o to open in a browser.

Build

npm run build

Generates output in dist/. To view locally, run

cd dist
python -m http.server