https://github.com/grame-cncm/fausteditor
A simple Faust editor for the web
https://github.com/grame-cncm/fausteditor
faust
Last synced: about 1 year ago
JSON representation
A simple Faust editor for the web
- Host: GitHub
- URL: https://github.com/grame-cncm/fausteditor
- Owner: grame-cncm
- License: gpl-3.0
- Created: 2020-02-14T09:28:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-12T15:43:46.000Z (about 1 year ago)
- Last Synced: 2025-04-12T16:41:51.545Z (about 1 year ago)
- Topics: faust
- Language: JavaScript
- Size: 54 MB
- Stars: 8
- Watchers: 5
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING.txt
Awesome Lists containing this project
README
# Faust Editor
The online [Faust Editor](https://fausteditor.grame.fr) can be used to _edit_, _compile_ and _run_ Faust code from any Web Browser with [WebAssembly](http://webassembly.org) 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 Faust compiler with an efficient webassembly backend and offers polyphonic MIDI support.
## Features
The editor engine is based on [CodeMirror](https://codemirror.net/). 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
- [https://fausteditor.grame.fr](https://fausteditor.grame.fr): the official link on the Faust Editor website.
- [https://github.com/grame-cncm/fausteditor](https://github.com/grame-cncm/fausteditor): the github repository
## Development
### Notes
We use [Vite](https://vitejs.dev/) for development mode and builds. Dependencies include [CodeMirror](https://codemirror.net/5/) for providing an editor, [FaustWasm](https://github.com/grame-cncm/faustwasm) for compiling Faust DSP client-side, and [FaustUI](https://github.com/Fr0stbyteR/faust-ui) for rendering GUI widgets.
### Generating the faustsnippets
The `gFaustLibSnippets` content in the `src/codemirror/mode/faust/faustsnippets.js` file has to be manually updated with the result of the `faust2atomsnippets -s *.lib` command done in the Faust libraries folder.
### Setup
Clone and enter the repository, then run:
```bash
npm install
```
### Run in development mode (automatic reloading)
```bash
npm run dev
```
Then press o to open in a browser.
### Build
``` shell
npm run build
```
Generates output in `dist/`. To view locally, run:
``` shell
cd dist
python -m http.server
```