Therapy Dog - Server (Deposit Forms)

This is a Node.js and Ember application that provides:

• flexible forms for collecting files and metadata,
• an expression language for mapping form input to MODS and other XML schemas, and
• routines for packaging and submitting METS deposits to the CDR.

Setup for forms server development

Note: This application also requires therapy-dog-client to work correctly.

Install Node.js.

If you are using Homebrew on macOS:

brew install node16-lts

If you are using Git for Windows, install Node.js using the v4.x.x LTS package available at https://nodejs.org/en/.

Install Server Dependencies:

make deps

Copy the example forms and vocabularies:

make examples

Start the API server:

make run-server

The application also requires the therapy-dog client app. In a separate terminal, clone that app and follow its readme to install it. Then start the client:

make run-client

Visit http://localhost:4200/forms/test-form in your browser.

Setup for building forms only (not doing development)

Install Node.js as above.

Rather than installing dependencies using make deps as above:

cd server && npm ci

Copy the example forms and vocabularies:

make examples

Start the API server:

make run-server

The application also requires the therapy-dog client app. In a separate terminal, clone that app and follow its readme to install it. Then start the client:

make run-client

Visit http://localhost:4200/forms/test-form in your browser.

Documentation

More information can be found in the docs directory:

• docs/arrow.md -- description and examples of Arrow features
• docs/lifecycle.md -- where every part of deposits happen, from requesting a form to submitting to the CDR
• docs/mailer-testing.md -- how to test mailers in development
• docs/new-block.md -- how to add a new block type
• docs/types.md -- reference for the structures that appear in form definitions

To generate API documentation for the server:

make docs

This runs JSDoc, saving the output in the server/docs directory.

If make is unavailable

Copy the example forms and vocabularies:

cp server/data/forms/article.json.example server/data/forms/article.json
cp server/data/forms/catalog.json.example server/data/forms/catalog.json
cp server/data/forms/test-form.json.example server/data/forms/test-form.json
cp server/data/vocabularies/genre.json.example server/data/vocabularies/genre.json
cp server/data/vocabularies/genre.json.example server/data/vocabularies/issuance.json
cp server/data/vocabularies/language.json.example server/data/vocabularies/language.json
cp server/data/vocabularies/role.json.example server/data/vocabularies/role.json

Start the API server:

cd server && npm start

In a separate terminal, clone that app and follow its readme to install it. Then start the client:

cd client && npm start

How to add dependencies to server

The source code for some dependencies is added to the repository:

• for the server, production npm dependencies (those listed in server/package.json under "dependencies")

We don't add the source code for development npm dependencies (those listed in server/package.json under "devDependencies"), which are anything we need for development (for example, running tests) but not for actually running the client or server.

Add or remove dependencies separately from code changes. This makes reviewing a merge request a little easier, since we can look at our own code in separate commits.

git log --oneline should look like this: (most recent at top)

bbbbbbb Remove 'left-pad' dependency from server.
aaaaaaa Implement NIH left-padding to avoid dependency on 'left-pad'.
1234567 Ensure output is left-padded.
abcdefg Add 'left-pad' dependency to server.

To add a production npm dependency to server

npm install --save archiver
git add package.json node_modules/archiver
git commit -m "Add 'archiver' dependency to server."

To add a development npm dependency to server

npm install --save-dev xmldom
echo "node_modules/xmldom" >> .gitignore
git add package.json .gitignore
git commit -m "Add 'xmldom' devDependency to server."

How to run tests

make check (Runs server side unit tests)

License Information

Copyright 2017 The University of North Carolina at Chapel Hill

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.