Setting up the primo-explore-devenv

[atla5]

How do you set up your primo-explore-devenv and working on multiple views at a time?

Background

• customizations for the Primo NUI are managed as multiple views that are taken
• the primo-explore-devenv manages running and packaging these views via a series of gulp tasks

Desired Qualities

• easy to set up for new developers
• works well with the existing gulp create and gulp run tools
• leverages npm packages where possible
• easily configurability between views

BU Setup

1. download the primo-explore-devenv
2. replace primo-explore directory with primo-explore-bu

$ cd primo-explore/
$ rm -rf custom/ tmp/
$ git clone https://github.com/bulib/primo-explore-bu.git ./

3. each folder within it is its own view, containing a bunch of duplicate code and needing to be manually updated with changes done to the "main" view

Benefits

• easy to set up and rationalize with gulp
• 1 to 1 mapping of a folder to a package

Drawbacks

• duplicated code
• hard to keep updated across views

Proposal

• setup webpack to actively build into the primo-explore-devenv from a completely separate area of your machine
• track only one copy of your js, css, html, img, etc.
• manage what gets included in each view from a config file for each view
  • include, exclude, overwrite

Questions

• how to configure each config file
• whether there will be any latency and we'll still be able to live edit