This section describes what needs to be done to set up your environment to develop X applications.
You will need the following to build and run X applications
- A JDK
- Maven
- An IDE
- An X License
Install JDK
Ensure you have one of the following JDKs installed on your machine.
- JDK 8
- JDK 11
- JDK 17
You can download and install the JDK from here
Install Maven
X Platform modules implements several plugins for code generation and preparation of deployment artifacts that integrate into the build cycle. Currently, all these plugins are built for Maven. Therefore, Maven is the preferred tool to build X Platform applications.
You can download and install Maven from here.
Free Maven installation tutorials can be found at:
Please make sure you install Maven v3.0.4 or later.
Using Other Build Tools
The functionality of each Maven plugin implemented by the X Platform is also available as a CLI tool implemented by the core X runtime. In fact, the plugins and the CLI tools are each implemented using a common underlying API implemented by the X runtime. These CLI tools are intended for use with build tools other than Maven such as Gradle and Ivy
Set JAVA_HOME
Set the following in your environment
This setting is used by Maven to determine the JDK to use to build your X project.
Building Using Java 11 or Beyond
To run X code generation plugins and build the generated core, you would need to include the following additional dependencies in your Maven project. This is due to the removal of these packages from the JDK after JDK8
Versions
The versions above are the versions against which the X Platform has been tested.
Get an X License
An X Platform license is required to run Talon based microservices. Please contact Neeve Sales or Neeve Support to obtain a license. You will receive the following information in the license package.
- The license file
- Save that license to your home directory
- Credentials to the Neeve artifact repository
- Update your Maven settings.xml file with the supplied credentials as described in the license package.
See Working with Licenses for information on working with licenses.
The Neeve Artifact Repository
The Neeve repository is the main repository for X build artifacts. The repository is intended for use by build tools such as Maven, Ivy, and Gradle to download X artifacts and by you to manually download artifacts.
Setup your IDE
X applications can be developed using any IDE that supports developing of Java applications.