Module 4a: Setting Up IKL Environment
Full Video Transcript:
Hey guys. Welcome to today’s session. Today, we’ll be focusing on setting up your environment so that you can start scripting on Indeni Knowledge language. So, right off the bat, we’ll set you up with a Bitbucket account, how to leverage Bitbucket to fork one of our repositories, and then from there, using SourceTree to start editing and creating your own scripts.
So, for today’s session, it’s only going to be focused on setting up your environment. So, now that I have went ahead and created my account, I will be getting a verification email. And, let me go ahead and access my account. Really quick. I quickly just went and verified my email. You should be receiving it in your inbox. If you have any issues with that, please verify that you used the right email address.
Okay. So, I went ahead and clicked on ‘Verify my email’, and now I have an account. And, I’m going to go ahead and create a username in here. Let’s call it ‘charles-IK-Community’. All right. And, now that I have a unique username, I have gone ahead and logged into my Bitbucket account.
From here on out, you go ahead and go to the Bitbucket repository for Indeni Knowledge. The link will be provided in the description of this video below, but once you get here, you’ll have a public access to the repository that we’re leveraging for building new code into the Indeni Knowledge platform.
From here, you go ahead and click on the plus sign, and then you go ahead and click ‘Fork this repository’. And, go ahead and create a unique name for yourself. I think the best convention would be your username on the extended community – ‘IKP-indeni-knowledge’.
So, to download SourceTree, you can go ahead and quickly Google it. It’s a free Git GUI that you can use for both Mac and Windows. The installation process is a little different, but I’ll go ahead and show you how to do it on the Mac. So, let me go ahead and save it. Okay, now that it’s finished downloading, I’m going to go ahead and open the file, unzip it, open SourceTree. And, it’s going to ask you or warn you that the application was downloaded from the Internet. Go ahead and click ‘Open’. But, for future purposes, you’re going to want to move this to the Applications folder. And, I already have it in the Applications folder, so it’s not a big concern, but once you go ahead and move it to the Applications folder on the Mac, you’ll now be able to access it at any given time from the Applications folder.
Now, let’s go ahead and determine that we have SourceTree open. So, now that I’ve set up my account using OAuth on my SourceTree, I’m now able to connect remotely to my repository, which I named Charles-IKP-indeni-Knowledge. Let’s go ahead and clone your repository from the Bitbucket, onto your local repository. So, to do that, you press ‘Clone’. You press ‘Clone this repository’, ‘Clone in SourceTree’. And then, from there, determine where you want to designate the destination path. For purposes of testing, we’ll go ahead and put it on the desktop. Create a new folder called ‘testing’. Click ‘Create’, and ‘Open’. And, from here on out, what that means is it’s now going to clone the repository that we just forked from the Indeni Knowledge repository, and it’s going to copy all of the files over to your computer in the directory that you designated. Any changes you make are now going to be linked in some way to the Github repository, and you’ll start… You’ll now have to do certain things, such as pushing the code from your local repository into the remote Github repository that you just created. We’ll show you how to do that in a separate video, but for today’s purposes, let’s go ahead and clone it so that you can now access and play around on your local machine the code that is in your repository.
Okay. Now, we’ve created the repository. We’ve cloned it on our local computer. We now can play around with anything we want on it. The way to do this – and, the best way, in our opinion – is to use Sublime Text or any text editor of your choice; but for us and for the purposes of training, we’re going to show you how to play around with the code from your fork repository, copy it onto your local computer, using Sublime Text.
The best way to do this is to go ahead and open Sublime Text. And then, from here you can go ahead and click ‘Open’, and then go ahead and navigate to the directory where you cloned your Github repository. For me, it was under ‘Desktop’, and it was under ‘Testing’, and I go ahead and click ‘Open’. And now, you’re set up for an environment, so you can play around with our code that’s currently available publicly and start making edits if you want.
So, if you want, you can go into any of the devices that you may be interested, or maybe you might want to start writing scripts for a new device that we don’t have. So, let’s go ahead and just use an example.
Now, most of the IND scripts and most of the focus of the scripts that you’ll be working on will be under the ‘parsers’ folder. If you’re going to be making any changes or any new rules, that would be under the ‘rules’ folder. That’s the end of this session. If you guys have any questions, please pose it on the forums. Thank you.