VS Code Extension

The EDJX Toolkit is an open-source extension built for Visual Studio Code (VS Code) editor. Using this extension, you can develop and deploy serverless applications that use the EDJX platform.

Prerequisites

Make sure you have the required permissions to add or modify resources in the EDJX platform, which are based on group roles and permissions assigned to each role. See Roles and Permissions for details.

1. Install the Extension

To install the extension:

  1. Open VS Code.

  2. In the sidebar, click the Extensions icon.

  3. In the search box, enter edjx-vscode, and click Install.

  4. Restart the editor.

The EDJX extension displays in the sidebar.

2. Connect to the EDJX Platform

To connect to the EDJX Platform:

If you are not deploying an application to the default EDJX environment, make sure that you change the environment before you proceed.
  1. Sign up for an EDJX account.
    Create your login credentials here.

  2. Open VS Code.

  3. In the sidebar, click the EDJX extension icon.

  4. Click Connect to EDJX button.

  5. Enter your username and password in the prompt.

You are now connected to the EDJX platform as displayed in the following image.

+ vscode logged in

3. (optional) Switch the Organization

To switch the organization:

  1. Select a profile in the Profile panel.

  2. Click the organization from the list when prompted.

    vscode change org

4. Create an Application

  1. Hover over the Application panel.

  2. Click the Create Application (+) icon.

  3. Enter a name for the application you are creating.

The application displays in the Application panel.

5. Add a Function

Rust

  1. Open VS Code.

  2. Click the EDJX Extension.

  3. In the Profile panel, click Connect to EDJX.

    If you are already logged in, proceed to the next step.
  4. Hover over an Application and click the + icon.

    vscode add function 1

  5. Follow the prompts.

    vscode add function 2

    vscode add function 3

    vscode add function 4

    vscode add function 5

    vscode add function 6

    vscode add function 7

    vscode add function 8 rust

    The function saves under the selected application, and a new window opens with the project files displayed.

    vscode build function 1 rust

C++

  1. Open VS Code.

  2. Click the EDJX Extension.

  3. In the Profile panel, click Connect to EDJX.

    If you are already logged in, proceed to the next step.
  4. Hover over an Application and click the Add Function icon.

    vscode add function 1

  5. Follow the prompts.

    vscode add function 2

    vscode add function 3

    vscode add function 4 cpp

    vscode add function 5

    vscode add function 6

    vscode add function 7

    vscode add function 8 cpp

    The function saves under the selected application, and a new window opens with the project files displayed.

    vscode build function 1

6. Build the Function

Rust

  1. In the Explorer view, navigate to the folder where the function exists.

  2. Select the edjconfig.yaml file within your function folder.

  3. Click Build.

    vscode build function 2 rust

    VS Code initiates a terminal instance and the process executes.

  4. Press any key to close the terminal instance.

    vscode build function 3 rust

C++

  1. In the Explorer view, navigate to the folder where the function exists.

  2. Select the edjconfig.yaml file within your function folder.

  3. Click Build.

    vscode build function 2 cpp

    VS Code initiates a terminal instance and the process executes.

  4. Press any key to close the terminal instance.

    vscode build function 3 cpp

7. Deploy the Function

Rust

  1. In the Explorer view, navigate to the folder where the function exists.

  2. Select the edjconfig.yaml file within your function folder.

  3. Click Deploy Function.
    A confirmation dialog displays.

    vscode deploy function 1 rust

  4. Click Yes to proceed with deployment.
    The edjconfig.yaml file auto-populates the function_id.

    vscode deploy function 2 rust

C++

  1. In the Explorer view, navigate to the folder where the function exists.

  2. Select the edjconfig.yaml file within your function folder.

  3. Click Deploy Function.
    A confirmation dialog displays.

    vscode deploy function 1 cpp

  4. Click Yes to proceed with deployment.
    The edjconfig.yaml file auto-populates the function_id.

    vscode deploy function 2 cpp