Install and set up Skedulo Packages SDK

Install and set up the Skedulo SDK.

System requirements

  • Mac: macOS 10.14 (Mojave) or later
  • Windows: Windows 7 or later
  • Linux: The SDK is built using the Applmage extension, which supports all common Linux distributions.

SDK installation requirements

  • Open SSL
  • NodeJS v12 ONLY
  • Yarn v1.22 or later

Set up NodeJS

If you have, or need to use a version of NodeJS other than v12, please follow the below instructions to install Node Version Manager. This will allow you to use multiple NodeJS versions.

Otherwise follow the instructions in SDK Setup below.

Set up Node Version Manager

If you’re unsure which version of NodeJS you have, run node --version from your terminal.

  1. If you’re using macOS with homebrew:

    brew install nvm

    If you’re using Linux, WSL or another *nix OS, or don’t have homebrew installed follow the instructions from NVM provided here

  2. When NVM is installed, install NodeJS 12 and switch to it by running

    nvm install 12

    nvm use 12

  3. When finished using the SDK, you can switch to other versions of NodeJS as required. Ensure you switch back to NodeJS 12 before using the SDK.

Set up the SDK

  1. In the web application, click your user profile in the upper-right corner, then open Settings -> Extensions. Click the Download Packages SDK button in the upper-right corner to download and install the Packages SDK.

    You will see the following message when the installation is complete:

    “Welcome to Skedulo’s Packages platform. You need to setup self-signed SSL certificates to continue. Click here for instructions on how to do this.”

  2. Complete each of the system requirements. All three requirements must be met to proceed to the next stage.

    Connected Pages Install the correct versions of Node and Yarn using your preferred installer or download them:

  3. Set up the self-signed SSL certificates.

    For for the SDK to work, you will need a self-signed SSL certificate for your system.

    a. Click on the blue highlighted text link “here” in the welcome text of the homepage.

    b. This page provides you with tailored instructions on how to create locally signed SSL certificates and set them up.

    Connected Pages

After the SDK is installed and you have created the self-signed SSL certificate, the SDK will prompt you to enable Developer Mode in the Skedulo web application so that you can begin working on your customizations.

SDK Enable Dev Mode

Enable developer mode

To begin developing a package or standalone web extension, you will have to enable developer mode.

Prerequisite

You must have installed and set up the SDK and it must be running. This is detailed in the SDK Setup procedure above.

  1. In the Skedulo web application, click your user Profile -> Settings -> Extensions.

  2. In the Extensions section, click the Developer Mode Enabled toggle button at the upper-right.

    Enable developer mode

  3. When developer mode is turned on, the web app will connect to the SDK and display the development options.

    If it does not connect, check that your SSL certificates are set up correctly.

    The following screen message appears:

    “Welcome to Skedulo’s Packages platform. To begin, select one of the following options.”

    Connected Pages