The Object Library protects and supports management of Knowledge Objects, making it easy to access and deploy them.
Clone or download

README.md

KGrid Library

CircleCI GitHub release

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

For building and running the application you need:

Clone

To get started you can simply clone this repository using git:

git clone https://github.com/kgrid/kgrid-library.git
cd kgrid-library

Quick start

This quick start will run the activator and load two example knowledge objects for testing. This objects are located in the shelf directory at the root of the project. By default application will start up and PORT 8080.

$ mvn clean package
$ java -jar applicatoin/target/kgrid-activator*.jar

Alternatively you can use the Spring Boot Maven plugin like so:

mvn clean spring-boot:run

Once Running access the Activators Health Endpoint. All statuses reported should be UP

"status": "UP",
    "shelf": {
        "status": "UP",
  

Running the tests

Automated tests

Unit and Integration tests can be executed via

mvn clean test
mvn clean verify

Publish Documentation

Running Local Dev Docs Publish

npm install
npm run docs:dev

Build dist directory ready for publish

npm run docs:build`

CircleCi publishes the documentation use VuePress and the .circleci/vuepress_deploy.sh script. The gh-pages branch is used for the publishing process and setup in the GitHub repository's GitHub Pages.