dockerized version of ex libris primo new ui development environment
ensure the latest versions of docker
and docker-compose
are installed.
download the project with:
git clone https://github.com/thatbudakguy/primo-explore-devenv-docker.git
or download a zip file using the green download button above and unzip.
docker-compose.example.yml
contains an example configuration for the development environment. you will need to rename it docker-compose.yml
and make some changes (detailed below) to start working.
you need a view code package to use the development environment. you can provide your own by downloading it from the "back office", or acquire a fresh one from here.
to add a view to the development environment, ensure that the line:
volumes:
- /path/to/my/view/code/:/home/node/primo-explore-devenv/custom/NAME_OF_VIEW
appears in your docker-compose.yml
, where the path on the left is the absolute path to your view code folder.
VIEW
property in docker-compose.yml
to match the name you provided in the volumes
stanza, e.g. NAME_OF_VIEW
.PROXY
property in docker-compose.yml
.to start developing, open a terminal in this directory and run:
docker-compose up
localhost:8003/primo-explore/search?vid=NAME_OF_VIEW
.first, ensure that the line:
volumes:
- /path/to/my/other/view/:/home/node/primo-explore-devenv/custom/NAME_OF_OTHER_VIEW
appears in your docker-compose.yml
, providing access to the new view.
to change the currently displayed view, edit the VIEW
property in docker-compose.yml
, open a terminal in the project directory, and run:
docker-compose restart
VIEW
or PROXY
will require the above restart command to take effect.volumes
stanza.CENTRAL_PACKAGE
.first, make sure that the line:
volumes:
- ./:/home/node/primo-explore-devenv/packages
appears in your docker-compose.yml
file, so that packages will appear outside the container.
to create a package, open a terminal in this directory and run:
docker-compose run server gulp create-package
select a package when prompted. the zip file will appear in this folder.