VS Code Extension

This toolkit provides details about the EDJX open-source extension for the Visual Studio Code (VS Code) editor. This extension makes it easier for you to develop and deploy serverless applications that use the EDJX Platform.

You must have the latest version of VS Code for the OS you decide to use.

1. Install the Extension

After you have confirmed that the requirements are present on your system:

  1. Open VS Code.

  2. In the Activity Bar, click the Extensions icon.

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

  4. Restart the editor.
    The EDJX extension appears in the left navigation.

2. Connect to the EDJX Platform

Once you have installed the extension, you can connect to the EDJX Platform.

If you are not deploying to the EDJX environment, which is set by default, make sure you change your environment before you proceed.
  1. Sign up for an EDJX account.
    Create your Login Credentials Here.

  2. Open VS Code.

  3. Click the EDJX extension icon.

  4. Click Connect to EDJX.

  5. Enter your username and password.
    The EDJX extension panel populates with your configured information.

    vscode logged in

3. Switch the Organization

To switch the organization:

  1. In the Profile panel, click the Organization icon.

  2. In the prompt, select the Organization.

    vscode change org

4. Create an Application

  1. Hover over the Application panel.

  2. Click the Create Application icon.

    vscode app create

  3. Select the organization to create the application under.

  4. Enter a name for the application.

    vscode app create prompt

    The application appears in the Application panel.

5. Create a Function

  1. Hover over Application you just created, and click the Add Function icon.

    vscode add function 1

  2. Follow the prompts.

    vscode add function 2

    vscode add function 3

    vscode add function 4

    vscode add function 5

The function saves under the selected application.

6. Build the Function

  1. Click the Explorer view.

  2. Navigate to the folder where the function resides.

  3. Right-click the edjconfig.yaml file within your function folder.

    vscode function build

  4. Click Build Function.
    A confirmation dialog displays.

  5. Click Yes to proceed with the build process.
    VS Code initiates a terminal instance, the process executes, and then a confirmation dialog displays.

7. Deploy the Function

  1. Click the Explorer view.

  2. Navigate to the folder where the function resides.

  3. Right-click the edjconfig.yaml file within your function folder.

    vscode function deploy

  4. Click Deploy Function.
    A confirmation dialog displays.

  5. Click Yes to proceed with deployment.