@orbis-cascade/oca-central-package
v1.1.0
Published
Orbis Cascade Alliance primo-explore central package.
Downloads
1
Readme
Orbis Cascade Alliance primo central package
contents
| customization | description | repository | |-|-|-| | toggle institutions | allows the list of summit borrowing institutions to be collapsed & expanded | primo-explore-toggle-institutions |
installation
see the releases page for the repository to download CENTRAL_PACKAGE.zip
. this file can be uploaded to the Primo Back Office customization manager.
developing
you'll need the latest versions of docker and docker-compose.
the development environment has two parts:
- the central package code, located in
src
- a generic view package called ALLIANCE, located in
test
here's how to use them:
- start a development server with
npm start
. - results will be visible at http://localhost:8003/primo-explore/search?vid=ALLIANCE
- you can edit the code in the
src
folder to change the central package and the dev environment will automatically generatesrc/js/custom.js
. - if you install customization packages using npm, they will automatically be added to
src/js/custom.js
. - to test inheritance, you can also edit the code in the
test/ALLIANCE
folder as if you were developing that view. it will automatically refresh. - when finished, you can use
ctrl+c
to quit the dev environment and docker will clean up the container.
building
when you're finished making changes:
- run
npm run create-package
and chooseCENTRAL_PACKAGE
at the prompt. - a
CENTRAL_PACKAGE.zip
file will appear indist
(likely overwriting the previous one). - consider bumping the version number using
npm version
. - if you cut a new release, consider uploading the
CENTRAL_PACKAGE.zip
file as a build artifact of the github release.