cspace-ui

9.0.1 • Public • Published

cspace-ui

npm package continuous integration codecov

The CollectionSpace user interface for web browsers.

Release 5.0 or later of the CollectionSpace server is required. This application is not compatible with releases 4.5 and earlier.

Release 8.0 or later of the CollectionSpace server is recommended. See the release notes to use this application with earlier releases.

Installation

For CollectionSpace Administrators

The CollectionSpace UI is a JavaScript application that runs in a web browser. See the installation instructions to make the application available to your CollectionSpace users.

For CollectionSpace Developers

Node.js 20 and npm 10 are recommended to build the application. A minimum of Node.js 18 and npm 9 are required.

To download and install the source code of the application for development:

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

To run the application in development, using a remote back-end CollectionSpace server:

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

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

Alternatively, to run the application 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 specified server must be configured to allow CORS requests from http://localhost:8080.

See the developer documentation for instructions on building, testing, and running the source code.

About CollectionSpace

CollectionSpace is a community-supported collections management application for museums, historical societies, natural science collections, and more.

Package Sidebar

Install

npm i cspace-ui

Weekly Downloads

44

Version

9.0.1

License

ECL-2.0

Unpacked Size

23.2 MB

Total Files

1829

Last publish

Collaborators

  • dheles
  • mglyrasis
  • mark.cooper
  • ray-lee