Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.79 KB

README.md

File metadata and controls

50 lines (32 loc) · 1.79 KB
Raw

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

Update this README with information about your app.

Additional information

Other modules.

See project UIEXPMGR at the FOLIO issue tracker.

Other FOLIO Developer documentation is at dev.folio.org