Configuration: UI Module - ChrisMavrommatis/Binacle.Net GitHub Wiki

The UI Module introduces a user-friendly frontend to Binacle.Net, primarily designed for demonstration purposes. Instead of interacting with the API directly, users can explore and interact with the features of Binacle.Net through a visual interface. This makes it easier to showcase functionality and demonstrate how the system works.

Features

• Packing Demo: This demo allows users to input bin and item data, and submit packing requests to Binacle.Net’s API. The results are displayed visually, showing how items are packed into each bin. Users can interact with the demo by stepping through the packing process item by item, using controls to see exactly how each item is placed within the bins.

Enabling the UI Module

To enable the UI Module, set the following environment variable: UI_MODULE=True, or modify the Features.json file as shown below:

{
  "Features": {
    "SERVICE_MODULE": "NotSet",
    "SWAGGER_UI": "NotSet",
    "UI_MODULE": "True"
  }
}

Configuration

The configuration for the UI Module is located in /app/Config_Files/UiModule. Here’s the relevant structure:

app
└── Config_Files
    └── UiModule
        └── ConnectionStrings.json

Binacle API Configuration

The UI Module requires the location of Binacle.Net’s API to function. This can be configured by specifying the API endpoint in the ConnectionStrings.json file, as shown below:

{
  "ConnectionStrings": {
    "BinacleApi": "endpoint=https://localhost:7194/"
  }
}

Alternatively, you can provide the API connection string through the environment variable BINACLEAPI_CONNECTION_STRING.