Description

See how to download the example SDK module project which will be used for the remainder of this course.

Transcript

(open in window)

[00:00] In this lesson, we'll show where to find and how to obtain a working Ignition SDK example module for some initial familiarization. Our emphasis in this lesson will be on the indicated portion of the development workflow. Now that we have Git installed, we'll use it to pull a training repository from the IA GitHub website over to our development system. Once it's there, we can open it up as an SDK project in IntelliJ and begin our module development and build activities. Obviously, this is usually just a one time step. Once we have our working example pulled over and in place, the bulk of our efforts will be on iteratively developing, building and testing our module code. However, we will repeat these steps down the road when we'll need to obtain some SDK module tools to create a from-scratch new Ignition module. But that's a lesson for later. So here's the public Inductive Automation GitHub page, with this URL linked beneath this lesson.

[01:02] We're going to focus on the Ignition SDK training repository. So we will click on it to see its content up here, and a general readme section beneath it. More examples may get added to this repo over time. Now, if we're familiar with Git, we can simply clone this repository, or we can use the web UI to download the repository as a zip file and extract it to our projects directory. We'll opt for the first approach. So for us, the key piece of information is the location of this repo. So in our browser, we will click on its address and do Ctrl-C to copy its URL. Then we're going to want to have some destination for this repo to go to. On your development system, navigate to or create a destination folder or directory. I'm going to use this Ignition SDK folder. Then from a command shell open to that location, run the following command: git clone, and then paste the URL we copied earlier.

[02:08] When we run that command, Git will do its thing and pull over the desired repo into this location, as we now see here. So with this one simple command, we have now pulled this repo over to our dev machine, and within it, we see this specific SDK module example we're going to start from. We can repeat this process as many times as desired if we need to revert to an original starting version, or obtain some other repository. In the next lesson, we'll continue by opening this example in our IntelliJ, and then building it using Gradle into an installable Ignition module file.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.