Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 3.24 KB

README.md

File metadata and controls

71 lines (43 loc) · 3.24 KB

registry-admin

Web front-end for the Library Registry administrative interface.

Library Simplified Documentation

To see screenshots, read in-depth documentation, and find out more about the project, check out the Confluence site hosted by The New York Public Library.

Setup

This package is meant to be used with the Library Simplified Library Registry.

Use npm version

Suggested local folder setup:

  • /[path to project folder]/library_registry

To use the published version with your circulation manager, run npm install from the library_registry local installed repository.

Use local development version

Suggested local folder setup:

  • /[path to project folder]/library_registry
  • /[path to project folder]/registry_admin

If 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.

  1. Run npm link in this registry_admin repository,
  2. run npm link simplified-registry-admin from the library_registry repository,
  3. run the library registry using python app.py at the root in the library_registry repository,
  4. run the web interface using npm run dev at the root of this registry_admin repository,
  5. visit localhost:7000/admin/

Webpack will take care of compiling and updating any new changes made locally for development. Just refresh the page to see updates without having to restart either the library_registry or registry_admin servers.

Publishing

To publish a new version, you need to create an npm account and be a collaborator on the package. Then you can run npm publish from your local copy of the repository.

Tests

Like the codebase, all the unit tests are written in Typescript. Tests are written for all React components as well as redux and utility functions, and all can be found in their respective __tests__ folders.

To run the tests, perform npm test.

We use Travis CI for continuous integration. Any pull requests submitted must have tests and those tests must pass on Travis CI.

License

Copyright © 2015 The New York Public Library, Astor, Lenox, and Tilden Foundations

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.