Stripes UI for managing ERM usage statistics
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
icons
src
test/ui-testing
translations/ui-erm-usage
.eslintrc
.gitignore
.stripesclirc
CHANGELOG.md
CONTRIBUTING.md
Jenkinsfile
LICENSE
README.md
package.json

README.md

ui-erm-usage

Copyright (C) 2018 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

The ERM-Usage UI Module, or ui-erm-usage, is a Stripes UI module for managing usage statistics. It allows to enter credentials for accessing usage data providers. These credentials are used by the backend module mod-erm-usage to harvest usage statistics periodically.

Prerequisites

In order to view and log into the platform being served up, a suitable Okapi backend will need to be running. The Folio testing-backend Vagrant box should work if your app does not yet have its own backend module.

Additionally, until it is part of the Okapi backends, the mod-erm-usage module needs to be running.

Developing and Contributing to ERM-Usage/ERM Modules

  • See manual in FOLIO ERM platform.
  • If you want to clone ui-erm-usage locally to make local modifications or contribute to it, select ui-erm-usage as a module when executing stripes workspace.

Running

Note that the following commands require that stripes-cli is installed globally.

Run the following from the ui-erm directory to serve ui-erm-usage by itself using a development server:

stripes serve

Note: When serving up a newly created app that does not have its own backend permissions established, pass the --hasAllPerms option to display the app in the UI navigation. For example:

stripes serve --hasAllPerms

To specify your own tenant ID or to use an Okapi instance other than http://localhost:9130, pass the --okapi and --tenant options.

stripes serve --okapi http://my-okapi.example.com:9130 --tenant my-tenant-id

More info

Read the Stripes Module Developer's Guide.