Giter Club home page Giter Club logo

duraark-digitalpreservation's Introduction

duraark-digitalpreservation

Circle CI

Overview

This library is part of the DURAARK system and contains the Submission Information Package (SIP) generators and the Rosetta deposit components.

Information on the provided functionalities can be found in report D2.5 Software prototype v2, Section 4.5.

Dependencies

The service depends on the following DURAARK components:

Used By

This service is used by the

Installation

The following instructions will deploy the SailsJS-based service which exports a REST API.

Prerequisites

The deployment is tested on Ubuntu 14.04 LTS. Other Linux distribution should work too, but are not tested. Docker and Docker Compose are used for installation and have to be installed on the system you want to deploy the DURAARK system on. The following instructions assume that Docker and Docker Compose are installed on working on the system. See the above links on how to install them for various platforms. Git has to be installed, too.

It is also possible to install DURAARK on Windows and Mac users via the Docker Toolbox. Installing Docker Compose on windows is possible, but seems to be a bit of a hurdle. See this Stackoverflow answer for details.

Our recommended stack is to install DURAARK on a Docker-compatible Linux system or to use VirtualBox to install a Linux virtual machine on your Windows host.

Installation Steps

On the host you want to deploy the service execute the following steps (assuming that Docker and Docker Compose are installed and working):

> git clone https://github.com/DURAARK/duraark-digitalpreservation.git
> cd duraark-digitalpreservation
> docker-compose up -d

This will deploy the system in the current stable version (v0.7.0) which exposes its API at http://HOST_IP:5015/ (http://localhost:5015/ if you did the setup on your local host).

The files you want to use have to be put into the folder /tmp/duraark/files. You may want to also install the duraark-sessions, which acts as the data volume container for files in the DURAARK System.

Development Environment

To setup the environment follow these steps:

> git clone https://github.com/DURAARK/duraark-digitalpreservation.git
> cd duraark-digitalpreservation
> npm install
> docker-compose -f devenv-compose.yml build
> docker-compose -f devenv-compose.yml up -d

This will build the dockerized development environment. After building the docker container is started and you can access the service at http://localhost:5015. Changing the source code will live reload the container.

The files you want to use have to be put into the folder /tmp/duraark/files. You may want to also install the duraark-sessions, which acts as the data volume container for files in the DURAARK System.

Testing

Run npm test in the src folder.

Platform Support

This library is running on NodeJS and provides a Dockerfile for deployments on Docker-enabled hosts.

Public API

We are hosting a public API endpoint at

which also provides API documentation for the current stable version.

Demo

A public demo of the DURAARK System which incorporates this service is available here.

duraark-digitalpreservation's People

Contributors

martinhecher avatar dagedv avatar

Watchers

James Cloos avatar Thomas Krijnen avatar  avatar  avatar Besnik Fetahu avatar Ujwal Gadiraju avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.