IntelliJ setup instructions

[ajmacdonald]

IntelliJ Workspace Setup

Prerequisites

• Git is installed
• Java 11

Downloads

• Download IntelliJ IDEA Ultimate from here. Note that only the Ultimate Edition includes the Tomcat and TomEE plugin. (I couldn't configure the free "Smart Tomcat" plugin for the Community Edition properly)

• Download Apache Tomcat 9 (specifically the latest version apache-tomcat-9.0.96.zip) and extract its contents to a directory of your choice. We'll refer to this directory as [TOMCAT] in the instructions below.

  • To avoid potential permission issues later, ensure the proper permissions are set for the files. On macOS/Linux, run the command:

    chmod -R 755 [TOMCAT]/*
    

IntelliJ Workspace Setup

1. In IntelliJ, go to File > New > Project from Version Control (ensure Git is selected). Enter the URL https://github.com/voyanttools/trombone.git and select a directory where the project should be stored.

2. Again, navigate to File > New > Project from Version Control (with Git selected). Enter the URL https://github.com/voyanttools/Voyant.git and choose the directory where this project should be stored. When prompted to choose where to open the Voyant project, select New Window.

3. Switch back to the Trombone project window in IntelliJ (as Trombone will be the main project). You may close the Voyant project window if you want to.

4. Go to File > New > Module from Existing Sources... and select the directory where you cloned the Voyant project.

5. In the Import Module dialog, select Import module from external model > Maven. After importing, both projects should appear in the Project explorer.

6. Open IntelliJ > Settings ... and navigate to Build, Execution, Deployment > Compiler > Java Compiler. Ensure that the Target bytecode version is set to 11 for both the Voyant and trombone modules. Note: You need to repeat this step whenever you change or sync Maven dependencies (i.e. pom.xml)

7. Go to File > Project Structure... and ensure that under Project Settings > Project, the SDK is set to Java 11.

8. Navigate to Run > Edit Configurations..., click the + button, and select Tomcat Server > local.

9. In the Server tab, under the Application server setting, click Configure... to manage your Tomcat installations.

10. Add a new installation by clicking + and selecting the [TOMCAT] directory as both the Tomcat Home and Tomcat base directory. If IntelliJ doesn't recognize the installation properly, ensure that permissions are set correctly and restart IntelliJ to apply the changes. Click OK.

11. In the Application server dropdown, select the Tomcat instance you just added.

12. Update the URL setting to http://localhost:8080/voyant.

13. Switch to the Deployment tab and verify that Voyant:war exploded is listed. If it's not, click the + icon, select Artifact..., and then choose Voyant:war exploded. Make sure to change the Application context path to /voyant. Click OK to save and close the dialog.

14. Finally, start the server by clicking the green "Run" button at the top (a green triangle) to start the configuration.

IntelliJ Workspace Setup

Troubleshooting

Q: I see the error java: package sun.security.action does not exist
A: Ensure that the SDK is set correctly in the Project Structure dialog. Also, verify that both the SDK and Target bytecode version are set to Java 11.

[janisdd]

Here is the updated version. It's just inconvenient that we can't see the raw markdown from the comments.

IntelliJ Workspace Setup

Prerequisites

• Git is installed
• Java 11

Downloads

• Download IntelliJ IDEA Ultimate from here. Note that only the Ultimate Edition includes the Tomcat and TomEE plugin. (I couldn't configure the free "Smart Tomcat" plugin for the Community Edition properly)

• Download Apache Tomcat 9 (specifically the latest version apache-tomcat-9.0.96.zip) and extract its contents to a directory of your choice. We'll refer to this directory as [TOMCAT] in the instructions below.

  • To avoid potential permission issues later, ensure the proper permissions are set for the files. On macOS/Linux, run the command:

    chmod -R 755 [TOMCAT]
    # or use quotes if the absolute path contains spaces
    chmod -R 755 "[TOMCAT]"
    

IntelliJ Workspace Setup

1. In IntelliJ, go to File > New > Project from Version Control (ensure Git is selected). Enter the URL https://github.com/voyanttools/trombone.git and select a directory where the project should be stored.

2. Again, navigate to File > New > Project from Version Control (with Git selected). Enter the URL https://github.com/voyanttools/Voyant.git and choose the directory where this project should be stored. When prompted to choose where to open the Voyant project, select New Window.

3. Switch back to the Trombone project window in IntelliJ (as Trombone will be the main project). You may close the Voyant project window if you want to.

4. Go to File > New > Module from Existing Sources... and select the directory where you cloned the Voyant project.

5. In the Import Module dialog, select Import module from external model > Maven. After importing, both projects should appear in the Project explorer.

6. Open IntelliJ > Settings ... and navigate to Build, Execution, Deployment > Compiler > Java Compiler. Ensure that the Target bytecode version is set to 11 for both the Voyant and trombone modules. Note: You need to repeat this step whenever you change or sync Maven dependencies (i.e. pom.xml)

7. Go to File > Project Structure... and ensure that under Project Settings > Project, the SDK is set to Java 11.

8. Navigate to Run > Edit Configurations..., click the + button, and select Tomcat Server > local.

9. In the Server tab, under the Application server setting, click Configure... to manage your Tomcat installations.

10. Add a new installation by clicking + and selecting the [TOMCAT] directory as both the Tomcat Home and Tomcat base directory. If IntelliJ doesn't recognize the installation properly, ensure that permissions are set correctly and restart IntelliJ to apply the changes. Click OK.

11. In the Application server dropdown, select the Tomcat instance you just added.

12. Update the URL setting to http://localhost:8080/voyant.

13. Switch to the Deployment tab and verify that Voyant:war exploded is listed. If it's not, click the + icon, select Artifact..., and then choose Voyant:war exploded. Make sure to change the Application context path to /voyant. Click OK to save and close the dialog.

14. Finally, start the server by clicking the green "Run" button at the top (a green triangle) to start the configuration.

Troubleshooting

Q: I see the error java: package sun.security.action does not exist
A: Ensure that the SDK is set correctly in the Project Structure dialog. Also, verify that both the SDK and Target bytecode version are set to Java 11.

[ajmacdonald]

Hi @janisdd, thanks again for this. I've added this to the wiki and credited you.