@triply/ldwizard-core

LDWizard-Core

The core functional implementation of the LD Wizard Interface.

You can use this package in order to build your own LD Wizard Application.

See the LD Wizard design document for more information about the LD Wizard framework.

See the Cultural Heritage Wizard for an example of a fully configured implementation for a specific domain.

Building your own LDWizard package

• Install Node.js and Yarn.

  On Ubuntu this is done with the following commands. Check the project websites for installation on other operating systems.

  curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
  curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
  echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
  sudo apt update
  sudo apt install nodejs yarn
  

• Add this package to your dependencies via

  • Yarn

    yarn add @triply/ldwizard-core
    

  • NPM

    npm install @triply/ldwizard-core
    

• Create a configuration file

  // This is a template file
  import WizardConfig from @triply/ldwizard-core/lib/WizardConfig;
  const wizardConfig: WizardConfig = {};
  export default wizardConfig;
  

• Run the script to create you local instance

  • Yarn

    yarn exec ldwizard-build path/to/configFile.ts
    

  Your package should now be available in the lib directory

Building your own LDWizard container

• Follow the steps from [Building your own LDWizard package]
• Run docker build -f ./docker/Dockerfile -t "my-docker-tag" --build-arg CONFIG_FILE=path/to/configFile.ts.

Local use / development

To start using a local instance for testing/development follow these steps

• Install Node.js and Yarn.

  On Ubuntu this is done with the following commands. Check the project websites for installation on other operating systems.

  curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
  curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
  echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
  sudo apt update
  sudo apt install nodejs yarn
  

• Clone this repository and go into its root directory.

• Run yarn to install the dependencies.

• Run yarn dev to start the LD-wizard in local development with the default configuration.

• Go to http://localhost:4000 in your favorite web browser.

Creating a new version

yarn build && yarn publish