| 1 | # cspace-ui
|
| 2 |
|
| 3 | [](https://www.npmjs.com/package/cspace-ui)
|
| 4 | [](https://travis-ci.org/collectionspace/cspace-ui.js)
|
| 5 | [](https://coveralls.io/github/collectionspace/cspace-ui.js?branch=master)
|
| 6 |
|
| 7 | The CollectionSpace user interface for web browsers.
|
| 8 |
|
| 9 | Release 5.0 or later of the CollectionSpace server is required. This application is not compatible with releases 4.5 and earlier.
|
| 10 |
|
| 11 | Release 5.1 or later of the CollectionSpace server is recommended. See the [release notes](https://github.com/collectionspace/cspace-ui.js/tree/master/RELEASE_NOTES.md) to use this application with earlier releases.
|
| 12 |
|
| 13 | ## Installation
|
| 14 |
|
| 15 | ### For CollectionSpace Administrators
|
| 16 |
|
| 17 | The CollectionSpace UI is a JavaScript application that runs in a web browser. See the [installation instructions](https://github.com/collectionspace/cspace-ui.js/tree/master/docs/installation) to make the application available to your CollectionSpace users.
|
| 18 |
|
| 19 | ### For CollectionSpace Developers
|
| 20 |
|
| 21 | [Node.js](https://nodejs.org/) 8 and npm 5 are required to build the application.
|
| 22 |
|
| 23 | To download and install the source code of the application for development:
|
| 24 |
|
| 25 | ```
|
| 26 | $ git clone https://github.com/collectionspace/cspace-ui.js.git
|
| 27 | $ cd cspace-ui.js
|
| 28 | $ npm install
|
| 29 | ```
|
| 30 |
|
| 31 | See the [developer documentation](https://github.com/collectionspace/cspace-ui.js/tree/master/docs/developer) for instructions on building, testing, and running the source code.
|
| 32 |
|
| 33 | ## About CollectionSpace
|
| 34 |
|
| 35 | [CollectionSpace](http://www.collectionspace.org/) is a free, open-source collections management application for museums, historical societies, natural science collections, and more.
|