Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 3.99 KB

README.rdoc

File metadata and controls

89 lines (57 loc) · 3.99 KB

DMP Online

DMP Online is the DCC’s data management planning tool, available at dmponline.dcc.ac.uk

Development of the DMP Online by the Digital Curation Centre has been funded by JISC. JISC inspires UK colleges and universities in the innovative use of digital technologies, helping to maintain the UK’s position as a global leader in education. www.jisc.ac.uk

This is just the application code, the accompanying question data available at dmponline.dcc.ac.uk is not included.

The tool has three main functions

  1. To help create and maintain different versions of Data Management Plans;

  2. To provide useful guidance on data management issues and how to meet research funders’ requirements;

  3. To export attractive and useful plans in a variety of formats.

Documentation & Support

Bugs & Feature Requests

Prerequisites

DMP Online is a Ruby on Rails application and you’ll need to have Ruby 1.9.2 or greater installed on your server and a MySQL server v5.0 or greater.

Further details on how to install Ruby on Rails applications are available from the Ruby on Rails site, rubyonrails.org

While not a prerequisite, we are running this using Phusion Passenger 3 (www.modrails.com) with an Apache webserver on Red Hat Enterprise Linux v5.

For the PDF conversion we use the shell utility wkhtmltopdf (code.google.com/p/wkhtmltopdf) which will need to be installed on your server.

Getting Started

After downloading, create a config/database.yml file based on the provided config/database_example.yml file. Currently only MySQL databases are supported.

Edit the configuration files at config/environments to include your contact email addresses.

Edit the configuration setting config.action_mailer.default_url_options in config/application.rb

Edit values for config.mailer_sender and config.pepper in config/initializers/devise.rb

Set a secret token in config/initializers/secret_token.rb

Review the application configuration settings in config/initializers/dmponline.rb

If wkhtmltopdf is not installed to /usr/local/bin/wkhtmltopdf then you will need to edit the config value in config/initializers/wicked_pdf.rb

You’ll need to install the gems, build the database and then (in a development environment) start the server:

$> bundle update
$> rake db:setup
$> rails server

Then go to localhost:3000

The database seed data will give you three users:

[email protected]

Full system admin user

[email protected]

A dummy organisation admin user

[email protected]

A normal end user

The password for each of these is ‘password’

Tools Being Used

DMP Online is built using a number of other open source projects, including

Active Admin

A framework for creating administration-style interfaces.

Formtastic

A DSL for semantically building forms.

Devise

User authentication is done using Devise

jQuery UI

Library of user interface effects built on the jQuery JavaScript library. jqueryui.com

Highcharts JS

JavaScript library for creating interactive charts. Not free for commercial use: shop.highsoft.com/highcharts.html

Iconic Icons

SVG icon set designed by P.J. Onori: somerandomdude.com/projects/iconic

wkhtmltopdf

A command line tool for creating PDFs from HTML: code.google.com/p/wkhtmltopdf/

SWORDv2 Repository Posting

The SWORD functionality is drawn from coding by Cottage Labs done as part of a JISC-funded University of Oxford DMP Online project to extend this application.

Copyright © 2012 Digital Curation Centre, University of Edinburgh. See AGPL-LICENSE for details.