https://github.com/mjordan/islandora_workbench_desktop

Desktop application that runs on top of the Islandora Workbench command-line tool.
https://github.com/mjordan/islandora_workbench_desktop

Last synced: 29 days ago
JSON representation

Desktop application that runs on top of the Islandora Workbench command-line tool.

• Host: GitHub
• URL: https://github.com/mjordan/islandora_workbench_desktop
• Owner: mjordan
• License: unlicense
• Created: 2019-08-11T20:38:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T22:04:13.000Z (almost 2 years ago)
• Last Synced: 2024-10-08T08:32:25.405Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 1.09 MB
• Stars: 1
• Watchers: 3
• Forks: 8
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Islandora Workbench Desktop

Desktop application that provides a graphical user interface for the [Islandora Workbench](https://github.com/mjordan/islandora_workbench) command-line tool. 

## Requirements

* [Islandora Workbench](https://github.com/mjordan/islandora_workbench)

* [Electron](https://electronjs.org/docs/tutorial/installation)

## Installation

1. Install Islandora Workbench.

1. Install Electron.

1. `git clone https://github.com/mjordan/islandora_workbench_desktop.git`. It is best (see below) that you clone this repository into a directory that is a sibling of the directory that Islandora Workbench is installed in.

1. `npm install`

1. Copy the `workbench_desktop.yml` file into the Islandora Workbench directory.

## Usage

### Preparing configuration files

You can use Workbench Desktop with any Islandora Workbench configuration file, with one difference: all file paths in configuration files must be absolute or relative to the Workbench Destop directory. For example, if Islandora Workbench and Islandora Workbench Desktop are installed in sibling directories, the relative file path in the `input_dir` configuration setting would look like this:

```yaml

input_dir: ../workbench/input_data

```

A sample configuration file, `workbench_desktop.yml`, is included with Workbench Desktop to illustrate this requirement.

### Running Workbench Desktop

> Note: The spreadsheet editor, added in commit 360d454fd683af5e962090b38b7c4b7cdff92087, is still a work in progress.

1. Make sure your Islandora instance is running.

1. In the Islandora Workbench Desktop directory, open a terminal and run `npm start` (we will eventually provide a clickable icon for Workbench Desktop, like any other desktop application has).

1. You will need to tell Workbench Desktop where the `workbench` exectuble script is. To do this, open the "Application" menu and choose the "Set path to workbench" item. A file selector dialog box will appear; browse to the `workbench` script and select it. *You only need to do this once,* not every time you run Workbench Desktop.

1. To execute Workbench Desktop, you will need to select a configuration file. To do this, open the "Task" menu and choose "Choose a configuration file". Only YAML files show up in this file chooser.

1. After you've selected your configuration file, you are ready to check your configuration and data. Click on the "Check configuration and data" button. You will then see the output of Workbench's checks:

    ![Workbench checks](docs/images/workbench_desktop_check.png)

1. If the checks pass, you can then run the task (create new content, update content, etc.). Click on the "Run task" button. You will then see the output of the task. As each node and media is created/updated/deleted, a message will be added to the output. When finished, it will look similar to this, depending on the task:

    ![Workbench task output](docs/images/workbench_desktop_run_task.png)

If you ran a create task (for example), the nodes and media will be in your Islandora instance:

![Workbench Desktop with output](docs/images/content.png)

### Viewing the Workbench log

To view Workbench's log file, open the "Applicaiton" menu and choose "View log file", or hit Ctrl-l (L). The log (which currently must be in the default location) will appear:

![Workbench Desktop with output](docs/images/workbench_desktop_view_log.png)

To return to the main window, open the "Applicaiton" menu and choose "Return to main window", or hit Ctrl-m.

## License

The Unlicense.