1 Setup Java JDK
The JDK™ is a development environment for building applications, applets, and components using the Java programming language.
Go to the Oracle website to download the Java™ Platform, Standard Edition Developement Kit:
VersionVersion 11 is required to compile Axional solutions.
Choose the installer according to your platform.
Run the downloaded file and follow the steps:
2 IntelliJ IDEA
IntelliJ IDEA is an integrated development environment (IDE) used in Java programming.
Visit the IntelliJ website to download IntelliJ IDEA (community is sufficient, but consider trying ultimate):
VersionThis tutorial has been made with version 2018.3 of IntelliJ IDEA, and also will work for version 2019.1
Follow the installation guide. You can use the suggested settings.
3 Mercurial client
Get a Mercurial Client, e.g. command-line based hg or GUI based SourceTree
4 General IDE Setup
Make sure you have hg installed on your machine. Intellij IDEA needs to know the path to hg to integrate it. To set it, from the start window, go to
Configure -> Preferences
Version Control -> Mercurial from the left side menu.
In the text field labeled
Path to hg executable you must enter your path to hg (on UNIX-like systems you can get it by entering "which hg" in a terminal)
Also notice that all our projects use ISO-8859-1 Encoding. The encoding can also be set in the preferences window:
Now, from the start screen, go to
Configure -> Project Defaults -> Project Structure
In the new window click on choose
New... -> JDK then navigate to a valid Java SDK installation on your machine. You should get a result like this:
Confirm with OK to get back to the start screen.
5 Importing a gradle project
From the start screen, choose
Import Project, then navigate to a valid Gradle project folder. In the next window choose
In the next window check the
Finish. The import process can take a lot of time depending on the size of the project.
6 Configuring project before running
Before running Axional Studio some things will have to be checked.
Firstly, it is probable that after the import of the project some files have been modified or deleted due to import settings. Go to Version Control tab and revert all changes if necessary.
Restart IntelliJAfter revert changes, restart IntelliJ to apply changes.
Secondly, for the axional-studio-core project to work with the webapps project, a softlink named webapp has to point to [User's Projects]/axional-studio-webapps/src/main/webapp
In a terminal, cd to axional-studio-core project root folder, then type
ln -s [Your Projects]/axional-studio-webapps/src/main/webapp webapp
Finally, it is probable that the file [Your Projects]/axional-studio-core/conf/config.xml does not exist or has to be modified. Talk to your administrator for obtaining the updated file.
7 Running the project
After these changes, several configutarions will be available to execute.
The are two ways to run Axional Studio:
- Application (IntelliJ)
Next it will show how to run Axional Studio in both ways,but first the watches of WebApp and WebOS will be started.
7.1 Start WebApp/WebOS watch
Before running Axional Studio the watches of WebApp and WebOS have to be started to create the distributions of WebApp and WebOS.
To do this the following configurations will be executed:
- WebApp watch
- WebOS watch
NodeJSNodeJS has to be installed to run watches.
7.2 Run with Gradle
Run Studio Boot configuration to start Axional Studio locally.
7.3 Run with IntelliJ
To run Axional Studio with IntelliJ some tasks have to be done before.
Firstly, on a terminal, cd to axional-studio-core project root folder, then type
cp -R build/resources/main/* out/production/resources
cp -R ../axional-server-core/build/resources/main/* ../axional-server-core/out/production/resources
Afterwards, try to start Axional Studio running Studio StartUp configuration.
It is probable that some errors appear on build, in this case go to code and use automatic suggests to solve them.
Finally, run again Studio Startup to start Axional Studio locally.
8 Improve performance of IntelliJ (recommended)
8.1 Exclude innecesary folders
Some project folders may cause indexing ad other processes to take too long.
To avoid this, this folders can be excluded:
8.2 Add webpack configuration file
Set webpack configuration file to