Skip to content
Create bags based on BagIt profiles and send them off into the ether (EasyStore is now DART)
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
apps
bagit
builtin
core
locales
migrations
plugins
test
ui
util
.appveyor.yml
.gitignore
.travis.yml
README.md
_config.yml
build-cli.sh
cibuild.sh
dart.js
jsdoc.sh
package-lock.json
package.json

README.md

APTrust DART

Build Status Build status Maintainability

DART is the Digital Artefact Routing Tool: a GUI and command-line tool for creating archival packages and sending them across a network to a remote repository. You'll find a working prototype of the GUI application in the dart-prototype repository.

While the prototype was a proof of concept, and was used successfully in production by a number of organizations, its underlying code was not suitable for long-term maintenance.

This repository contains refactored code which is meant to be the foundation of a viable community-supported project.

DART Core Features

  • Create Submission Information Packages (SIPs) in BagIt format that conform to pre-configured BagIt profiles
  • Define your own custom BagIt profiles
  • Support additional SIP formats (tar, zip, parchive, etc) in the future
  • Send SIPs across a network to be ingested into a repository using S3, FTP, SFTP, and other protocols.
  • Define jobs that describe what items should be packaged, how, and where the should be sent.
  • Implement all features as plugins, using a well-defined plugin interface so developers can add new features without having to dig into core code.
  • Provide all of these features in a simple drag-and-drop, point-and-click UI that non-technical users can operate with minimal learning curve.
  • Provide all of these features in a well-defined command-line interface, so they can be scripted using any scripting language.

DART Refactor

The goal of the refactor is to create maintainable, extensible code so other developers can contribute to DART.

  1. Separate concerns so core code can run in the Electron UI or from the command line.
  2. Refactor duplicated code into base classes or helpers.
  3. Standardize APIs so they're more intuitive.
  4. Use idiomatic JavaScript.
  5. Strive for full test coverage with Jest.
  6. Document all relevant code with JSDoc.

Testing

Jest runs tests in parallel by default, but this can cause problems when different tests are saving different AppSetting values as part of their setup process. The --runInBand flag tells Jest to run tests sequentially.

See the Jest CLI reference

npm test -- --runInBand

Testing on Windows

A number of tests will fail on Windows if git is set to automatically convert line endings from \n to \r\n. Specifically, tests involving bag validation and checksums will fail because the git checkout on Windows adds an extra byte to the end of each line of each text file.

If you want these tests to pass, you'll need to disable git's automatic newline transformations with the following command:

git config --local core.autocrlf false

Documentation

After every commit the documentation is rebuilt and published at

https://aptrust.github.io/dart

Building the Docs

./jsdoc.sh

After running that, check the index.html file in the docs directory, which the command will create if it doesn't already exist.

Building Apps with Nexe

The nexe npm package builds Node.js scripts into standalone executables. DART executables are in the apps directory. You can compile them with the command below. Be sure to run this from the top-level directory, or the executable will be broken due to bad internal paths.

./build-cli.sh

Note that all of the DART command line tools will be built into a single executable called dart-cli. This is in part because nexe binaries are large (over 40 MB) and include only about 200k-800k of JavaScript. Better to distribute one 40 MB binary than ten.

The other advantage to having a single binary is that when we update core DART code, we have to redistribute only one binary instead of ten.

You can’t perform that action at this time.