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.

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.

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 CollectionSpace services on the specified server must have been deployed with the build-time environment variable CSPACE_CORE_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.

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

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