Developing for the IDE

This material has been superseded. Visit learn.bela.io for the maintained version.

In order to contribute to the development of the Bela IDE please follow these instructions to setup your workflow. The workflow is designed for a host running OS X but should also work with linux.

Node.js version 6 or greater is required on the host computer.

After cloning this repository, navigate to the Bela/dev directory and run npm install from a terminal. You may also need to run sudo npm install -g gulp and input your password.

With your Bela board connected via USB and booted up, run gulp from the dev directory. gulp automatically looks for changes in the source code of the IDE, compiling and transpiling it using browserify, babel and other tools and uploading it to the board. If you are using the livereload chrome plugin it will automatically refresh your browser page so you can see any changes you have made as soon as possible. gulp will output any errors in the compilation process to the terminal, and will also display the stdout & stderr log of the node.js IDE application running on the board.

The source files for the client-side browser application live in dev/src. Please edit these files and not IDE/public/js/bundle.js which is generated automatically by gulp.

The source files for the node.js application running on the board are located in IDE/libs. These can be edited directly.

Due to the development Gulp application using rsync and physically uploading the file to your board if you have a previous SSH fingerprint in your known-hosts file you will have to remove it or you will only see MITM warnings in your console.

In POSIX environments you can remove the fingerprint safely with ssh-keygen -R 192.168.7.2.