HiveUI Metadata Ingestion

Ingestion frontend for the HIVE experiment at UKAEA

Docker

To run the UI with Docker, clone the repository and add Keycloak credentials to the docker-compose.yaml file:

AUTH_SECRET="<openssl rand -hex 32>"
AUTH_KEYCLOAK_ID="<KeycloakClientID>"
AUTH_KEYCLOAK_SECRET="<KeycloakClientSecret>"
AUTH_KEYCLOAK_ISSUER="http://<KeycloakURL>/realms/<realm name>"
PUBLIC_ROOT_FOLDER_LOCATION="<Full path to the KeyChallenge4 folder (no slash at end)>"

Then run the following command:

docker-compose up -d

The UI will be available at http://localhost:3000

Development - Prerequisites

Before you begin, ensure you have met the following requirements:

You have installed the latest version of Node.js and npm

Developed with Node.js v21.1.0 and npm v10.2.0

Installing HiveUI

Clone the repository:

git clone https://github.com/BDevT/HiveUI.git

Navigate to the project directory:
```
cd HiveUI
```
Install the dependencies:
```
npm install
```

Create a .env file in the root directory with the following content:

AUTH_SECRET="<openssl rand -hex 32>"
AUTH_KEYCLOAK_ID="<KeycloakClientID>"
AUTH_KEYCLOAK_SECRET="<KeycloakClientSecret>"
AUTH_KEYCLOAK_ISSUER="http://<KeycloakURL>/realms/<realm name>"
PUBLIC_ROOT_FOLDER_LOCATION="<Full path to the KeyChallenge4 folder (no slash at end)>"

Running HiveUI (Development)

Run a development server with npm:
```
npm run dev -- --open
```

The UI will be available at http://localhost:5173

Running HiveUI (Production)

Build with npm:
```
npm run build
```
Serve with npm:
```
npm run preview
```