reidbee3/brays

Metadata workflow utility

Brays

Metadata editor utility built on Electron.

Optional

ImageMagick

In order the view tiff files in the viewer, you must have ImageMagick installed.

Download ImageMagick for Windows and ensure you have "Install legacy utilities" checked during install.

MacOS via Homebrew:

brew install imagemagick

Linux (Debian):

apt-get install imagemagick

To Use

Clone and run this repository. You will need Node.js installed. From the command line:

git clone https://github.com/uhlibraries-digital/brays
# Go to the repository
cd brays
# Install dependencies and run the app
npm install && npm start

Packaging

You can package Brays by running the following commands based on your target system:

• npm run package:mac will package for MacOS X x64
• npm run package:win will package for Windows x64
• npm run package:linux will package for Linux x64
• npm run package will package all the above

All packages are stored in the app-builds directory that gets created during the build process.

In addition you can create distributions using the following command: npm run dist. Distributions will be stored in the release directory.

To learn more about distributing, please read the Application Distribution documentation from Electron.

Development

Brays is built with Angular 4 using Typescript. The main application starts in main.ts.

To build the application you can run one of these commands:

• npm run build will build the application
• npm start will build the application and start it

You need run a build npm run build before running npm start for the first time. You will only need to do this once.

License

MIT License