{"id":29687308,"url":"https://github.com/thepalaceproject/circulation-admin","last_synced_at":"2026-02-26T20:22:48.376Z","repository":{"id":37851944,"uuid":"364637538","full_name":"ThePalaceProject/circulation-admin","owner":"ThePalaceProject","description":"Circulation Manager web admin interface ","archived":false,"fork":false,"pushed_at":"2025-06-28T07:01:09.000Z","size":58153,"stargazers_count":1,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-28T08:18:15.035Z","etag":null,"topics":["circulation-manager","frontend","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"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/ThePalaceProject.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"zenodo":null}},"created_at":"2021-05-05T16:19:33.000Z","updated_at":"2025-06-18T15:06:46.000Z","dependencies_parsed_at":"2023-12-02T08:22:40.433Z","dependency_job_id":"b49a44c8-4ddd-4861-9abd-5aa9b7ed9b9f","html_url":"https://github.com/ThePalaceProject/circulation-admin","commit_stats":null,"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"purl":"pkg:github/ThePalaceProject/circulation-admin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThePalaceProject%2Fcirculation-admin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThePalaceProject%2Fcirculation-admin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThePalaceProject%2Fcirculation-admin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThePalaceProject%2Fcirculation-admin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThePalaceProject","download_url":"https://codeload.github.com/ThePalaceProject/circulation-admin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThePalaceProject%2Fcirculation-admin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266619025,"owners_count":23957273,"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","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["circulation-manager","frontend","typescript"],"created_at":"2025-07-23T04:36:38.869Z","updated_at":"2026-01-27T22:26:06.138Z","avatar_url":"https://github.com/ThePalaceProject.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Circulation Manager Administrative Interface\n\n[![Test Client \u0026 Deploy Documentation](https://github.com/lyrasis/simplye-circulation-web/actions/workflows/test-and-deploy.yml/badge.svg?branch=main)](https://github.com/lyrasis/simplye-circulation-web/actions/workflows/test-and-deploy.yml)\n\nThis is a [LYRASIS](http://lyrasis.org)-maintained fork of the NYPL [Library Simplified](http://www.librarysimplified.org/) Circulation Manager administrative interface.\n\n## Library Simplified Documentation\n\nTo see screenshots, read in-depth documentation, and find out more about the project, check out the [Confluence](https://confluence.nypl.org/display/SIM/) site hosted by The New York Public Library.\n\n## Set Up\n\nThis package may be used in a local build of the Palace Project [Circulation Manager](https://github.com/ThePalaceProject/circulation), or it may be run against a remote Circulation Manager.\n\nThis project uses Node.js 20. We recommend the latest version of Node.js 20.\n\nYou have a number of options for installing Node.js. One convenient way on macOS is to use Homebrew and nvm to manage Node.js versions.\n\nInstall Homebrew if you have not already:\n\n```\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n```\n\nInstall nvm using Homebrew:\n\n```\nbrew install nvm\n```\n\nInstall and use the latest version of Node.js 18, e.g. 18.14.2 with nvm:\n\n```\nnvm install 20.18.3\nnvm use 20.18.3\n```\n\nAlternatively, you can use `nodenv` on macOS:\n\n```\nbrew install nodenv\nnodenv install 20.18.3\nnodenv global 20.18.3\n```\n\nIf you have different projects requiring different Node.js versions, you can use nodenv to set a local version for the project by navigating to the root directory of circulation-admin and executing `nodenv local 18.14.2`.\n\nYou can also use the `n` npm package to manage Node.js versions, or simply install the Node.js binary directly.\n\nThis project uses the latest version of npm. You can update npm with `npm update -g npm`. You can confirm the versions of Node.js and npm you are using with `node --version` and `npm --version`.\n\nOnce you have installed the correct versions of Node.js and npm, run `npm i` to install all dependencies.\n\n#### Use npm-Published Version in a Local Circulation Manager\n\nSuggested local folder setup:\n\n- `/[path to project folder]/circulation`\n\nTo use the published version with your circulation manager, run `npm install` from `api/admin` in the `circulation` local installed repository.\n\n#### Use Local Development Version in a Local Circulation Manager\n\nFollow the Circulation Manager README instructions before setting up this repository.\n\nSuggested local folder setup:\n\n- `/[path to project folder]/circulation`\n- `/[path to project folder]/circulation-admin`\n\nIf you're working on the administrative interface and want to test local changes, you can link your local clone of this repository to your local circulation manager. These steps will allow you to work on the front-end administrative interface and see updates while developing.\n\n1. Run `npm link` in this `circulation-admin` repository,\n2. run `npm link @thepalaceproject/circulation-admin` from `api/admin` in the `circulation` repository (which is where package.json is located),\n3. run the circulation manager using `python app.py` at the root in the `circulation` repository,\n4. run the web interface using `npm run dev` at the root of this `circulation-admin` repository,\n5. run the Elasticsearch server using `./bin/elasticsearch` in the elasticsearch-[version] directory,\n6. visit `localhost:6500/admin/`.\n\nWebpack will take care of compiling and updating any new changes made locally for development. Just hard refresh the page (command + shift + R) to see updates without having to restart either the `circulation` or `circulation-admin` servers.\n\n#### Use Local Development Version with a Remote Circulation Manager\n\nThis front-end may be run locally in development against a remote Circulation Manager back-end. This removes the need to build a local Circulation Manager from source in order to work on the front-end.\n\n1. Specify a back-end and start the dev server. You have two options:\n\n   - Create an `.env` or `.env.local` file in the root of the project and assign `BACKEND=https://gorgon.tpp-qa.lyrasistechnology.org`. Run `npm run dev-server`.\n\n     Note: `dotenv -c` loads `.env.local` then `.env` in that order and will not overwrite variables set by the previous file.\n\n   - Run `npm run dev-server -- --env=backend=[url]` in this `circulation-admin` repository. Providing `--env=backend=` will override `.env` and `.env.local`.\n\n     Example: `npm run dev-server -- --env=backend=https://gorgon.tpp-qa.lyrasistechnology.org`\n\n     Note: The tortured syntax here results from going through npm and webpack. The first `--` separates arguments intended for npm from arguments intended for the script that npm runs. In this case the script executes webpack, which allows an environment object to be supplied on the command line using `--env`. Properties of the environment object are specified using the `--env=[property]=[value]` syntax.\n\n1. Visit `http://localhost:8080/admin/`.\n1. Log in using credentials for the CM back-end. Content from that Circulation Manager should appear.\n\nThis works by running a local proxy server. HTML pages received from the Circulaton Manager that load assets from the `circulation-admin` package on jsdelivr are rewritten to load them from the local webpack build instead.\n\nWebpack will take care of compiling and updating any new changes made locally for development. Hot module replacement and live reloading are enabled, so the browser will automatically update as changes are made.\n\n## Web Catalog\n\nThe Circulation Manager administrative interface relies on the [OPDS Web Catalog](https://github.com/ThePalaceProject/web-opds-client) as its base React component and application. For more information, please check out that repository.\n\n## Publishing a New Release\n\nThis package is [published to npm](https://www.npmjs.com/package/@thepalaceproject/circulation-admin) automatically\nvia a GitHub Actions workflow when a release is created.\n\nWhen you are ready to publish a release, go to the GitHub repository and create a new release. Specify the version\nnumber as the tag (e.g., `v1.2.3`), add a release title, and use GitHub's \"Generate release notes\" feature to\nautomatically create documentation based on the PRs included in the release. After reviewing the generated notes,\npublish the release. The GitHub Actions workflow will automatically build, test, and publish the package to npm.\n\n## Accessibility\n\nIn order to develop user interfaces that are accessible to everyone, there are tools added to the workflow. Besides the Typescript `tslint-react-a11y` plugin, `react-axe` is also installed for local development. Using that module while running the app uses a lot of resources so it should be only when specifically testing for accessibility and not while actively developing new features or fixing bugs.\n\nIn order to run the app with `react-axe`, run `npm run dev-test-axe`. This will add a local global variable `process.env.TEST_AXE` (through webpack) that will trigger `react-axe` in `/src/index.tsx`. The output will be seen in the _browser's_ console terminal.\n\n## Tests\n\n### Unit Tests\n\nLike the codebase, all the unit tests are written in Typescript. Tests are written for all React components as well as redux and utility functions. Older tests are run using mocha and these tests can be found in the `__tests__` folders littered throughout the `src` tree. All new tests should be written using jest and placed in the `tests/jest` directory. The directory structure in `tests/jest` should mirror the structure in `src`.\n\nTo run the tests, perform `npm test`.\n\nWe use GitHub Actions for continuous integration. Any pull requests submitted must have tests and those tests must pass on GitHub Actions.\n\n### Nightwatch\n\nThere are end-to-end tests that run on Nightwatch. This selenium-based test runner allows us to include integration tests for logging into the admin and clicking through different pages.\n\nTo set up credentials and run the tests, check out the [README](/tests/README.md) in `/tests/.\n\n## Debugging\n\nThe [Redux DevTools browser extension](https://github.com/reduxjs/redux-devtools/tree/main/extension) may be used to easily inspect app states and state transitions.\n\n## License\n\n```\nCopyright © 2021 The New York Public Library, Astor, Lenox, and Tilden Foundations\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthepalaceproject%2Fcirculation-admin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthepalaceproject%2Fcirculation-admin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthepalaceproject%2Fcirculation-admin/lists"}