React-JUCE-Examples

ATTENTION

This repo is currently a work in progress pushed publicly for the purposes of testing CI workflows whilst it's initial structure is completed. This message will be removed once react-juce-examples is ready for general use.

A collection of example plugins/apps built with the React-JUCE framework.

TODO:

Add instructions for building JS bundles in Debug/Release as well as hot-reloading.

Examples

GainPlugin

GainPlugin A simple GainPlugin showing the basics of a React-JUCE implementation.

Building the Examples

CMake

React-JUCE-Examples supports CMake as a build system. To build the examples simply run CMake against the root directory/CMakeLists.txt and use your preferred generator.

We suggest performing an out-of-source build by creating a build directory adjacent to your react-juce-examples checkout.

Run the following in Powershell/Cmd on Windows or Terminal on Mac.

mkdir react-juce-examples-build
cd react-juce-examples

CMake Build Via Ninja (Mac + Linux + Windows)

# Change to -DCMAKE_BUILD_TYPE=Release to see react-juce's
# Release build performance.
cmake ../react-juce-examples -G Ninja -DCMAKE_BUILD_TYPE=Debug .

# Build the example plugin you want to test.
# You can append _Standalone to the plugin target name if you just
# want to test a standalone version rather than making the example
# plugin available in your DAW/Host of choice.
ninja -j8 GainPlugin_Standalone

# If building standalone plugin variant run the following
# from the react-juce-examples-build directory to launch.
examples/GainPlugin/GainPlugin_artefacts/Debug/Standalone/ReactJUCEGainPlugin

CMake Build Via XCode (Mac)

# Change to -DCMAKE_BUILD_TYPE=Release to see react-juce's
# Release build performance.
cmake ../react-juce-examples -G Xcode -DCMAKE_BUILD_TYPE=Debug .

# Open the generated XCode project in XCode IDE and build/run
cmake --open .

CMake Build Via Visual Studio (Windows)

# Change to -DCMAKE_BUILD_TYPE=Release to see react-juce's
# Release build performance.
cmake ../react-juce-examples -G "Visual Studio 16 2019" -A x64 -DCMAKE_BUILD_TYPE=Debug . 

# Open the generated Solution in Visual Studio IDE and build/run
cmake --open .

Projucer

Apologies, Projucer support is currently broken for react-juce. We're in the process of providing a solution for Projucer builds.

Building React UIs (Hot Reloading)