ui-ill

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

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-ill-ui and start your development.

The Foundry Module SDK ILL developer loop documents running the released ILL application, then substituting this UI checkout as a Lattice microfrontend for local development.

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 new app

Run the following from the ui-ill-ui directory to serve your new app 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

Run the tests

GitLab runs yarn build:ci after dependency installation, then yarn test. The CI build uses the Stripes application bundler with this module's real app and settings imports; unresolved named exports are errors. It needs no running tenant. RxJS 6 supplies the peer required by Redux Observable 1 and Stripes. The release job waits for both compilation and tests before publication.

To reproduce locally with Node 22:

yarn install
yarn build:ci
yarn test

The copyright form regression executes its query callback and checks the actual endpoint URL, so a dependency missing that endpoint cannot pass behind a mock.

Run the included UI test demo with the following command:

stripes test --run demo --show

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.