https://github.com/folio-org/ui-agreements
Stripes front end module for ERM module
https://github.com/folio-org/ui-agreements
Last synced: 10 months ago
JSON representation
Stripes front end module for ERM module
- Host: GitHub
- URL: https://github.com/folio-org/ui-agreements
- Owner: folio-org
- License: apache-2.0
- Created: 2018-03-13T11:05:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T14:29:38.000Z (about 2 years ago)
- Last Synced: 2024-04-13T16:38:00.676Z (about 2 years ago)
- Language: JavaScript
- Size: 7.2 MB
- Stars: 2
- Watchers: 24
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# ui-agreements
Copyright (C) 2018-2022 The Open Library Foundation
This software is distributed under the terms of the Apache License, Version 2.0. See the file "[LICENSE](LICENSE)" for more information.
## Introduction
The Agreements UI Module, or `ui-agreements`, is a Stripes UI module used for management of various E-resource tasks including handling agreements and viewing available E-resources.
## 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](https://app.vagrantup.com/folio/boxes/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-agreements](https://github.com/folio-org/mod-agreements) module needs to be running.
## Running
Note that the following commands require that [`stripes-cli`](https://github.com/folio-org/stripes-cli) is installed globally.
Run the following from the ui-agreements directory to serve `ui-agreements` 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
```
To run `ui-agreements` within a Stripes platform:
1. Create a workspace with `stripes workspace` and select whatever modules you want (e.g., `ui-users` and `ui-agreements`) and at least one platform such as `stripes-sample-platform`.
1. Navigate to the platform's directory and run `stripes serve stripes.config.js.local`.
## Additional information
Read the [Stripes Module Developer's Guide](https://github.com/folio-org/stripes/blob/master/doc/dev-guide.md).
Other [modules](https://dev.folio.org/source-code/#client-side).
See project [UIER](https://issues.folio.org/browse/UIER)
at the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker).
Other FOLIO Developer documentation is at [dev.folio.org](https://dev.folio.org/)