cspace-ui-plugin-profile-bonsai/README.md

Bonsai profile plugin for the CollectionSpace UI

# cspace-ui-plugin-profile-bonsai

[![npm package](https://img.shields.io/npm/v/cspace-ui-plugin-profile-bonsai.svg)](https://www.npmjs.com/package/cspace-ui-plugin-profile-bonsai)
[![continuous integration](https://github.com/collectionspace/cspace-ui-plugin-profile-bonsai.js/actions/workflows/ci-js.yml/badge.svg?branch=master&event=push)](https://github.com/collectionspace/cspace-ui-plugin-profile-bonsai.js/actions/workflows/ci-js.yml)

Bonsai profile plugin for the CollectionSpace UI.

## Installation

### For developers

Follow these instructions to download and install the source code of the plugin.

Using git:

```
$ git clone https://github.com/collectionspace/cspace-ui-plugin-profile-bonsai.js.git
$ cd cspace-ui-plugin-profile-bonsai.js
$ npm install
```

To run the cspace-ui application configured with this plugin in development, using a remote
back-end CollectionSpace server:

```
$ npm run devserver --back-end=https://bonsai.dev.collectionspace.org
```

Then open a browser to http://localhost:8080.

Alternatively, to run the cspace-ui application configured with this plugin in development, using
the UI configuration in index.html:

```
$ npm run devserver
```

By default, the configuration in index.html uses the CollectionSpace services API located at
http://localhost:8180. To run the application against CollectionSpace services located on a
different host, edit index.html, and change the `serverUrl` configuration property. Note that the
CollectionSpace services on the specified server must have been deployed with the build-time
environment variable `CSPACE_BONSAI_UI_BASE_URL_OPT` set to `http://localhost:8080/` (note the
trailing slash). This ensures that CORS and OAuth on the server are configured to allow connections
from the locally running UI.