/ikm-framework

A demonstration of a plugin-framework that can enable basic and plugin extensions to a knowledge-management application.

Primary LanguageJava

Demonstration plugin framework for orchestrating the Komet application.

Team Ownership - Product Owner

FDA Shield - Client

Getting Started

Follow the instructions below to set up the local environment for ikm-framework:

  1. Download and install Open JDK Java 19

  2. Download and install Apache Maven 3.9 or greater

  3. There are dependencies to building ikm-framework. Please ensure you have a reliable internet connection when cloning and building to get all dependencies from Maven Central.

  4. Komet is a dependency for ikm-framework which is not currently provided on Maven Central. Please refer to the Komet README for building instructions.
    NOTE: The komet.version property in the ikm-framework/pom.xml file must align with the Komet version built in this step.

Building and Running IKM-Framework

Follow the steps below to build and run ikm-framework on your local machine:

  1. Clone the ikm-framework project from GitHub to your local machine
git clone [Repo URL]

  1. Navigate to the ikm-framework directory

  2. Enter the following command to build the application:

mvn clean install

Issues and Contributions

Technical and non-technical issues can be reported to the Issue Tracker.

Contributions can be submitted via pull requests. Please check the contribution guide for more details.