ui-finance

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

The ui-finance allows for the management of ledgers, funds, and budgets in FOLIO. It includes a dashboard that provides a snapshot of your account totals for the current fiscal year across ledgers and funds.

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-finance directory to serve your new app using a development server:

stripescli 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:

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

stripescli serve --okapi http://my-okapi.example.com:9130 --tenant my-tenant-id

Run the tests

Run the included UI test demo with the following command:

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