IntelliJ configuration

Prerequisites:

• Intellij Idea CE

Configuration:

1. Clone Giskard repo: git clone [<https://github.com/Giskard-AI/giskard.git>](<https://github.com/Giskard-AI/giskard.git>)

   • If needed to install Java here’s how to do it

2. from giskard directory run ./gradlew build

   • If you were prompted by FAILURE: Build failed with an exception.

3. Open Intellij Idea CE and select “Open” project by specifying path to the cloned repo. After an indexing is done you should see a structure like this:

   (Install Intellij Idea CE if needed using: https://formulae.brew.sh/cask/intellij-idea-ce)

• Optional keymap configuration

Giskard is composed of 3 components:

• java backend
• vue.js frontend
• python ML worker

1. Backend run configuration

   1. Make sure you select Java 17 as a project SDK (Cmd + ;), install it if needed

      

   2. Open GiskardApp class (Cmd + N) and right click on it to select “Run”

      

      • Run it. You should see something like this in the output: “Application 'giskard' is running!”

2. Frontend run configuration

   • Add new run configuration by clicking on “Edit Configurations…”
   • Create a Shell Script configuration, call it “Frontend” and use “Script text” mode
   • Run it, you should see “App running at:” in the output

3. ML Worker run configuration

   • Install Python plugin from Preferences (Cmd + ,)
   • Open project settings (Cmd + ;) and add a Python interpreter for ML Worker (created by gradle build)
   • In the project settings and configure python-client module to use python interpreter that you’ve configured at a previous step
   • Open giskard/python-client/giskard/cli.py (Cmd + Shift + N) , right click inside of it and select “More Run/Debug” → “Modify Run Configuration”

If everything was done correctly, you should be able to open http://localhost:8080

Login/password are admin/admin