zburke / ui-data-export

UI module: data export managing

ui-data-export

Copyright (C) 2020 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

Application for data export functionality.

Installation

First, a Stripes UI development server needs to be running. See the quick start instructions, which explain how to run it using packages from the FOLIO NPM repository or use some parts from local in-development versions.

The other parts that are needed are the Okapi gateway, various server-side modules, and sample data. Ways to achieve that are described in Running a complete FOLIO system.

(At some point, this process will be dramatically streamlined; but at present, this software is primarily for developers to work on, rather than for users to use.)

Build and serve

To build and serve ui-data-export in isolation for development purposes, run the "start" package script.

$ yarn start

The default configuration assumes an Okapi instance is running on http://localhost:9130 with tenant diku. The options --okapi and --tenant can be provided to match your environment.

$ yarn start --okapi http://localhost:9130 --tenant diku

See the serve command reference in stripes-cli for a list of available options. Note: stripes-cli options can be persisted in configuration file for convenience.

Additional information

Project code style guide. Other modules.

See project UIDEXP at the FOLIO issue tracker.

Other FOLIO Developer documentation is at dev.folio.org