# KGrid Quick Start

CircleCI

TIP

Confirm Node and NPM (version 10+) are installed, and Java 8+ JDK is installed.

# Step 1 - Install the KGrid CLI

> npm install -g @kgrid/cli

# Step 2 - Install a micro-grid in your project directory(KGrid workspace)

> mkdir myproject
> cd myproject
> kgrid setup

The terminal might show the following messages:

KGrid CLI v0.4.0

Setting up kgrid at /Users/pboisver/dev/foof/.kgrid

Downloading kgrid components... done

kgrid setup complete

# Step 3 - Start a local grid

Start KGrid & verify in the browser that the activator and library are running

> kgrid start

The terminal might show the following messages:

java -jar .../kgrid-library-1.2.3.jar ... --server.port=8081

java -jar .../kgrid-activator-1.1.5.jar ... --server.port=8080

library: You have the latest version.

Starting KGrid library...

activator: You have the latest version.>

Starting KGrid activator...

...

TIP

You can stop the local micro-grid with ctrl-C or open an additional terminal tab or window to continue.

TIP

Once the Library (http://localhost:8081) and Activator (http://localhost:8080) are running you can open a browser window verify that both are running

The Library will be empty and the Activator should show an empty KO list, {}.

# What's next?

If you'd like to load existing Knowledge Objects to the Activator or Library, KGrid team has developed several collections of KOs you can try:

Example Collection

CPIC Collection

More information on KO collections can be found at https://kgrid-objects.github.io/

If you'd like to create a new Knowledge Object, please refer to Developer's Guide

Last Updated: 12/18/2019, 3:25:56 PM