Explorer application

• Getting the source
• Development
  • Production build
  • Development watch
    • Node
      • NVM (Node Version Manager)
      • AVN (Automatic Version Switching for Node)
    • Enonic XP development mode
    • Watching (using Gradle or Node)
    • Browser sync
• Admin tool

Getting the source

$ git clone [email protected]:enonic/app-explorer.git && cd app-explorer

or

$ git clone https://github.com/enonic/app-explorer.git && cd app-explorer

Development

There are two main ways of developing:

Production build

This will use java libraries listed under dependencies in build.gradle to build an application jar file. Depending upon you hardware this may take a minute.

$ enonic project gradle clean build deploy

If you are using SNAPSHOT versions of java libraries you can refresh dependencies like this:

$ enonic project gradle clean build deploy --refresh-dependencies

Development watch

In order to save time one can watch for changes (in src and javascript dependencies) to rebuild as few files as possible. Depending upon you hardware this may take less than a second. In order to do this you will first have to install a production build of the application and do some changes to the development environment:

Node

In order to build you need to have the correct version of Node installed. You can see the selected version in the gradle.properties and .node-version files. A good way to install multiple versions of Node is to use NVM:

NVM (Node Version Manager)

You can install or update nvm like this:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash

or wget

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash

Ref: https://github.com/nvm-sh/nvm

Then you can install the version of Node you want like this:

$ nvm install 10.16.0

AVN (Automatic Version Switching for Node)

Different projects often use different versions of Node. Remembering to switch is pain, so I would suggest using AVN. It will read the .node-version file when you cd into a folder and automatically switch to the correct Node version.

You can install avn like this:

npm install -g avn avn-nvm avn-n
avn setup

Ref: https://github.com/wbyoung/avn

Then you can simply cd into a project folder an AVN will active the correct version

$ cd app-explorer
avn activated v10.16.0 (avn-nvm v10.16.0)

Enonic XP development mode

You will have to run Enonic XP in development mode:

$ enonic sandbox start sandbox-name -dev

Watching (using Gradle or Node)

$ enonic project gradle clean watch

Browser sync

There are two webpack configs beeing built. One for Enonic XP server-side controllers, and one for client-side Ecmascript modules. When running watch in development mode browser-sync will proxy http://localhost:8080/ twice.

• http://localhost:3000/ for server-side updates
• http://localhost:3002/ for client-side updates

Admin tool

On a development laptop the Explorer admin to is usually available here:

• http://localhost:8080/admin/tool/com.enonic.app.explorer/explorer