primo-explore-nyu has been consolidated into the monorepo primo-explore-views
This the NYU Libraries primo-explore view package.
For more information about primo-explore views please review the example package that this package was cloned from: https://github.com/ExLibrisGroup/primo-explore-package.
For information about developing in the primo-explore UI please review that relevant repository: https://github.com/ExLibrisGroup/primo-explore-devenv
For more information about NYU's customizations read the wiki.
With recommended volumes enabled in the docker-compose.yml
:
With Docker and docker-compose installed:
- Configure
docker-compose.yml
to fit your institutional setup in thex-environment
section. docker-compose build web
VIEW=NYU docker-compose up web
On your local machine, the developer server will be accessible at http://localhost:8004/primo-explore/search?vid={VIEW}
Within the docker network, this will be accordingly be accessible at the address http://web:8004
You can mount your local central-package
directory with compiled assets to the container's own CENTRAL_PACKAGE
web:
volumes:
- /path/to/primo-explore-central-package:/primo-explore/custom/CENTRAL_PACKAGE
If you need to actively develop with your local view and central package together, you can perform the following separate containerized processes.
primo-explore-central-package
:
Mount local central package rep to volumes
web:
volumes:
- ./:/primo-explore/custom/CENTRAL_PACKAGE
then run
service web
(without exposing ports) to dynamically recompile JS/CSS.
docker-compose run web
primo-explore-nyu
:
docker-compose up web
With recommended volumes enabled in the docker-compose.yml
:
NODE_ENV=[stage] docker-compose run create-package
This will output a package to your ./packages/
directory
Integration/end-to-end testing has been implemented in cypress. Cypress can run in its own container connected to a running web-test
service.
Simply execute:
docker-compose run e2e