Getting Started

This guide assumes you have some familiarity with React.js and with JUCE, and it is therefore recommended that you spend some time getting comfortable there, if you're not already, before embarking on this guide.


To get started with React-JUCE, you'll first need to install a few dependencies:

  • Node.js v8.11.0+

  • npm v5.6.0+

  • JUCE v5.4.2+ (Optional if you are only running the examples)

  • Xcode10.2+ (MacOS)

  • Visual Studio 2017+ (Windows)

Once you have the dependencies installed, we need to clone the React-JUCE repository itself. React-JUCE's git repository contains necessary submodules, so we'll need to collect those as well, which we can do one of two ways:

$ git clone --recurse-submodules [email protected]:nick-thompson/react-juce.git


$ git clone [email protected]:nick-thompson/react-juce.git
$ cd react-juce
$ git submodule update --init --recursive

Note that the [email protected] prefix here indicates cloning via SSH. If you prefer to work with git via HTTPS you'll want to swap in in the above commands.

At this point, we've got everything ready to get our project up and running. Let's move on to the next step, running the demo plugin.