This document describes the required software and tools used for setting up and developing LexEVS.
Required Software
Below are the required software and tools necessary to build/compile/develop LexEVS.
- Java JDK 8
- Apache Ant 1.9.3
- Apache Maven 3.3.9 (or greater)
- Git 2.9.2 (or greater)
Database
MySQL is used for LexEVS at NCI in production. This is what we use in development as well.
- MySQL 5.6.x
Additionally, the following lines need to be added to the my.cnf file:
- innodb_file_format=Barracuda
- innodb_file_per_table=true
- innodb_large_prefix=true
Eclipse
We are using Eclipse for our IDE. The instructions below are for setting up Eclipse. IntelliJ can also be used, if that is your preferred IDE.
- Download/install "Eclipse IDE for Java Developers". The latest version that has been used in development is Eclipse 2019-03 (4.11).
Setup
Get the LexEVS project
- Use git to clone the LexEVS project to your local system.
- LexEVS is located here:
- Checkout the latest branch. Currently it is "v6.5.3".
Build LexEVS
cd to the "lexevs" directory
- Build the project by running the command "ant"
This will download all the dependencies and build the LexEVS project.
Setup LexEVS in Eclipse
Install the ivy plugin for Eclipse
- Help -> Install New Software
- Add new website: http://www.apache.org/dist/ant/ivyde/updatesite
- This will search and return:
- Apache Ivy library
- Apache IvyDE Eclipse plugins
- Select both options
- Install and restart Eclipse when prompted
Update the Eclipse Ivy settings
Select Eclipse>Preferences
- Select Ivy→Settings
- Set the “Ivy settings path:” ${workspace_loc:lbPackager/ivysettings.xml}
Add the LexEVS Project
- Select File->Import…->Git->Projects from Git
- Select Next…
- Select Existing local repository
- Select Next…
- Select Add…
- Select the LexEVS git project that was previously built.
- Select Next…
- Select "Import Existing Eclipse Projects"
- Select Finish
Once the project is imported, select all of the project folders
- Right click and select Ivy->Resolve
Build LexEVS from Eclipse
You can now build the project in Eclipse.
- In the Project Explorer, right click on lbPackager
- Select Run As->Ant build