https://github.com/folio-org/ui-export-manager
https://github.com/folio-org/ui-export-manager
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/folio-org/ui-export-manager
- Owner: folio-org
- License: apache-2.0
- Created: 2021-02-10T00:50:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-06T22:20:18.000Z (about 1 year ago)
- Last Synced: 2025-06-06T23:25:19.336Z (about 1 year ago)
- Language: JavaScript
- Size: 406 KB
- Stars: 1
- Watchers: 18
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ui-export-manager
Copyright (C) 2021 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.
## 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.
## Run your app
Run the following from the ui-export-manager directory to serve your new app using a development server:
```
yarn 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:
```
yarn 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.
```
yarn stripes serve --okapi http://my-okapi.example.com:9130 --tenant my-tenant-id
```
## Run the tests
Run tests with the following command:
```
yarn test
```
## What to do next?
Now that your new app is running, search the code for "`stripes-new-app`" to find comments and subbed placeholders that may need your attention.
Read the [Stripes Module Developer's Guide](https://github.com/folio-org/stripes-core/blob/master/doc/dev-guide.md).
Update this README with information about your app.
## Additional information
Other [modules](https://dev.folio.org/source-code/#client-side).
See project [UIEXPMGR](https://issues.folio.org/browse/UIEXPMGR)
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/)