First, you need to have an account in KAGE platform to download the application template, and the correct Node.js environment to run the application in your localhost.
|Device is optional, and if you choose to use a device, you need to install a serial terminal program to configure it, and may even need to install device drivers.|
Must have in your local environment
- Application Template
- tar extraction program
|Unix based operating systems such as Mac and Linux have a built in tar extraction program. In windows, you need to install 7-zip or winzip to extract the tar file|
- serial terminal program
Node Version Manager (nvm)
Nvm allows you to install multiple version of Node.js in your localhost. It prevents your current Node.js environment from being polluted with old modules by creating a specific version of Node.js in its own environment.
The first release of our tracking application template (Shuriken) uses node v8.10.0, which is no longer the current version, so you will need to install this package if you do not have it already.
Mac and Linux
Use curl or wget
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.1/install.sh | bash
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.1/install.sh | bash
There is also a very good documentation found in the nvm github site (https://github.com/nvm-sh/nvm/blob/master/README.md)
For windows users, there is a similar tool that mimics the functionality of the nvm package. You can download it here
Documentation and installation instructions can be found on this site: https://github.com/coreybutler/nvm-windows/wiki
Use the node version manager to install the node v8.10.0
nvm install v8.10.0
To list the version on node in your local machine, run:
To select v8.10, run:
nvm use v8.10.0
Serial Terminal Program
If you need a serial terminal program (a program that communicates to your device via serial interface - usually via USB port on modern laptop), then this program can be downloaded in mac, linux and windows.
TAR File Extractor
The downloadable IOT NINJA Application Templates are downloaded as a compressed file in tar format. You need to extract it using an extraction program. Mac and Linux machine comes with a built in tar program that can do both compression and extraction.
Mac and Linux
To extract, open a command line terminal and run
tar -xzvf file.tar.gz
tar -zcvf file.tar.gz <folder>
Before you proceed, double check you can:
- Operate in Node.js v8.10.0
- Extract a tar file in your local machine