{"id":15550910,"url":"https://github.com/thatbudakguy/primo-explore-devenv-docker","last_synced_at":"2026-04-04T04:34:37.491Z","repository":{"id":71132663,"uuid":"88662848","full_name":"thatbudakguy/primo-explore-devenv-docker","owner":"thatbudakguy","description":"dockerized version of ex libris primo new ui development environment","archived":false,"fork":false,"pushed_at":"2017-11-08T23:51:58.000Z","size":11,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-03T19:32:17.853Z","etag":null,"topics":["docker","docker-compose","exlibris","primo","primo-explore"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thatbudakguy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-18T19:32:17.000Z","updated_at":"2018-10-01T12:09:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"b949ac05-5cea-4bea-9c2b-f67810236341","html_url":"https://github.com/thatbudakguy/primo-explore-devenv-docker","commit_stats":{"total_commits":14,"total_committers":1,"mean_commits":14.0,"dds":0.0,"last_synced_commit":"a613416418d06654ff1615e8f365d35801c2c9f9"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thatbudakguy%2Fprimo-explore-devenv-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thatbudakguy%2Fprimo-explore-devenv-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thatbudakguy%2Fprimo-explore-devenv-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thatbudakguy%2Fprimo-explore-devenv-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thatbudakguy","download_url":"https://codeload.github.com/thatbudakguy/primo-explore-devenv-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235217927,"owners_count":18954520,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","exlibris","primo","primo-explore"],"created_at":"2024-10-02T14:01:44.112Z","updated_at":"2026-04-04T04:34:37.453Z","avatar_url":"https://github.com/thatbudakguy.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Primo New UI Customization Docker Development Environment\n\n[![Build Status](https://travis-ci.org/thatbudakguy/primo-explore-devenv-docker.svg?branch=master)](https://travis-ci.org/thatbudakguy/primo-explore-devenv-docker) [![](https://images.microbadger.com/badges/version/watzek/primo-explore-devenv.svg)](http://microbadger.com/images/watzek/omeka \"Get your own version badge on microbadger.com\") [![](https://images.microbadger.com/badges/image/watzek/primo-explore-devenv.svg)](https://microbadger.com/images/watzek/omeka \"Get your own image badge on microbadger.com\")\n\n## Downloading:\n\nensure the latest versions of `docker` and `docker-compose` are installed.\n\ndownload the project with:\n```sh\ngit clone https://github.com/thatbudakguy/primo-explore-devenv-docker.git\n```\nor download a zip file using the green download button above and unzip.\n\n`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.\n\n## Usage:\n\n### Setup\n\nyou 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](https://github.com/ExLibrisGroup/primo-explore-package).\n\nto add a view to the development environment, ensure that the line:\n```yml\nvolumes:\n  - /path/to/my/view/code/:/home/node/primo-explore-devenv/custom/NAME_OF_VIEW\n```\nappears in your `docker-compose.yml`, where the path on the left is the absolute path to your view code folder.\n\n- to select a view, edit the `VIEW` property in `docker-compose.yml` to match the name you provided in the `volumes` stanza, e.g. `NAME_OF_VIEW`.\n- to select a proxy server to view live primo results, edit the `PROXY` property in `docker-compose.yml`.\n\nto start developing, open a terminal in this directory and run:\n```sh\ndocker-compose up\n```\n\n- logs will be displayed in your terminal.\n- you can edit the files in your package's folder and changes will be made in real-time.\n- you can observe the view using a browser at `localhost:8003/primo-explore/search?vid=NAME_OF_VIEW`.\n\n### Changing views\n\nfirst, ensure that the line:\n```yml\nvolumes:\n  - /path/to/my/other/view/:/home/node/primo-explore-devenv/custom/NAME_OF_OTHER_VIEW\n```\nappears in your `docker-compose.yml`, providing access to the new view.\n\nto change the currently displayed view, edit the `VIEW` property in `docker-compose.yml`, open a terminal in the project directory, and run:\n```sh\ndocker-compose restart\n```\n\n- making changes to `VIEW` or `PROXY` will require the above restart command to take effect.\n- you can add as many views as you like to the `volumes` stanza.\n- you can add a central package by mounting it in the above manner and naming it `CENTRAL_PACKAGE`.\n\n### Creating packages\n\nfirst, make sure that the line:\n```yml\nvolumes:\n  - ./:/home/node/primo-explore-devenv/packages\n```\nappears in your `docker-compose.yml` file, so that packages will appear outside the container.\n\nto create a package, open a terminal in this directory and run:\n```sh\ndocker-compose run server gulp create-package\n```\nselect a package when prompted. the zip file will appear in this folder.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthatbudakguy%2Fprimo-explore-devenv-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthatbudakguy%2Fprimo-explore-devenv-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthatbudakguy%2Fprimo-explore-devenv-docker/lists"}