How nyulibraries/primo-customization works
This repository customizes NYU’s Primo VE discovery interface across institution views, with shared directives and campus-specific assets. The primary workflow is to edit a view or shared customization, preview it in local Primo with CDN assets, then deploy CDN changes or create and upload a Primo customization package. The graph includes the shared browser runtime and the documented local proxy/CDN environment. Evidence is limited to the README and sampled source; unsampled customization and packaging internals are represented only at paths supported by the tree.
Main entry points: 08-servers.js Preview server · server.mjs Local CDN server · custom Institution views · primoProxy.js Primo proxy
Components 19
Primo customizations
- Institution views
custom - View HTML and CSS
custom/01NYU_INST-NYU - View color settings
custom/01NYU_INST-NYU/colors.json
Shared browser runtime
- Shared configuration
custom/00_common/js/01-config.js - Shared filters
custom/00_common/js/02-filters.js - Directive injection
custom/00_common/js/03-inject.js - LibKey integration
custom/00_common/js/04-libkey.js - Generated directives
custom/00_common/js/05-autogenerated-custom-directives.js - Runtime startup
custom/00_common/js/06-run.js - Angular module
custom/00_common/js/custom.module.js
Local preview
- Local CDN server
tools/cdn-server/server.mjs - Preview configuration
primo-explore-devenv/gulp/config.js - Primo proxy
primo-explore-devenv/gulp/primoProxy.js - Preview server
primo-explore-devenv/gulp/tasks/08-servers.js - Browser reload
primo-explore-devenv/gulp/browserSyncManager.js
Customization delivery
- Primo package
primo-explore-devenv/packages
Other components
- Customizer
- Primo VE
- CDN assets
Connections 15
- Customizer → Institution views: edits view
README.md - Customizer → CDN assets: edits assets
README.md - Institution views → View HTML and CSS: contains view files
- Preview server → Primo proxy: routes requests
primo-explore-devenv/gulp/tasks/08-servers.js - Preview server → Preview configuration: reads settings
primo-explore-devenv/gulp/tasks/08-servers.js - Preview server → Browser reload: starts server
primo-explore-devenv/gulp/tasks/08-servers.js - Primo proxy → Preview configuration: reads settings
primo-explore-devenv/gulp/primoProxy.js - Preview server → Primo VE: proxies requests
README.md - Customizer → Local CDN server: starts locally
README.md - Local CDN server → CDN assets: serves files
README.md - Customizer → Primo VE: opens preview
README.md - Primo VE → Local CDN server: loads custom assets
- Customizer → Primo package: creates package
README.md - Primo package → Primo VE: uploads package
README.md - Customizer → CDN assets: deploys changes
README.md