Getting started

Requirements

  • Gradle 5.1+
  • JDK 8+ 64 bits
  • The plugin is built and tested on Linux, Mac OS, Windows (see the list of build environments used in the contributing notes).

Supported distributions

Steps

Starting from release 3.0.1, ID org.siouan.frontend and classpath org.siouan:frontend-gradle-plugin:<version> are deprecated. If you are already using the plugin, we recommend upgrading to the latest release as soon as possible.

  1. Install the plugin.
    • Using Gradle DSL (recommended)

      plugins {
          // For JDK 11+
          id 'org.siouan.frontend-jdk11' version '5.0.1'
          // For JDK 8+
          id 'org.siouan.frontend-jdk8' version '5.0.1'
      }
      plugins {
          // For JDK 11+
          id("org.siouan.frontend-jdk11") version "5.0.1"
          // For JDK 8+
          id("org.siouan.frontend-jdk8") version "5.0.1"
      }
    • Using Gradle build script block

      buildscript {
          repositories {
              url 'https://plugins.gradle.org/m2/'
          }
          dependencies {
              // For JDK 11+
              classpath 'org.siouan:frontend-gradle-plugin-jdk11:5.0.1'
              // For JDK 8+
              classpath 'org.siouan:frontend-gradle-plugin-jdk8:5.0.1'
          }
      }
      
      // For JDK 11+
      apply plugin: 'org.siouan.frontend-jdk11'
      // For JDK 8+
      apply plugin: 'org.siouan.frontend-jdk8'
      buildscript {
          repositories {
              url = uri("https://plugins.gradle.org/m2/")
          }
          dependencies {
              // For JDK 11+
              classpath("org.siouan:frontend-gradle-plugin-jdk11:5.0.1")
              // For JDK 8+
              classpath("org.siouan:frontend-gradle-plugin-jdk8:5.0.1")
          }
      }
      
      // For JDK 11+
      apply(plugin = "org.siouan.frontend-jdk11")
      // For JDK 8+
      apply(plugin = "org.siouan.frontend-jdk8")
  2. Configure your project, optionally with the help of examples provided for typical use cases.
  3. Run gradlew build.
  4. If you need to run node/npm/npx/yarn executables from a command line (e.g. to start a development server), take a look at the FAQ.