DMP Roadmap is a Data Management Planning tool. Management and development of DMP Roadmap is jointly provided by the Digital Curation Centre (DCC), http://www.dcc.ac.uk/, and the University of California Curation Center (UC3), http://www.cdlib.org/services/uc3/.
Click here for the latest releases.
Roadmap is a Ruby on Rails application and you will need to have:
Further detail on how to install Ruby on Rails applications are available from the Ruby on Rails site: http://rubyonrails.org.
L'application se lance par défaut en mode développement.
See the Installation Guide on the Wiki.
# init submodule
git submodule init && git submodule update
Default credentials: admin@example.com
/ changeme
# Create directus database
docker compose exec -it postgres sh -c "psql -U ${DB_USERNAME:-postgres} -c 'create database ${DIRECTUS_DATABASE:-directus};'"
# Copy database dump file in postgres container
docker compose cp ./directus/dump.sql postgres:/directus.sql
# Apply dump in database
docker compose exec -it postgres sh -c "psql -U ${DB_USERNAME:-postgres} ${DIRECTUS_DATABASE:-directus} < directus.sql"
# Dump directus database
docker compose exec -it postgres sh -c "pg_dump -U ${DB_USERNAME:-postgres} ${DIRECTUS_DATABASE:-directus}" > directus/dump.sql
# build image
docker compose -f docker-compose.yml -f docker-compose-dev.yml --profile dev build dmpopidor
# Configure database connection for postgres (change postgres by mysql)
docker compose -f docker-compose.yml -f docker-compose-dev.yml --profile dev run --rm dmpopidor sh -c 'ruby bin/docker postgres'
# Setup database
docker compose -f docker-compose.yml -f docker-compose-dev.yml --profile dev run --rm dmpopidor sh -c 'bin/rails db:environment:set RAILS_ENV=development; ruby bin/docker db:setup'
# Run all services
docker compose -f docker-compose.yml -f docker-compose-dev.yml --profile dev up -d
# build image
docker compose --profile prod build dmpopidor
# Configure database connection for postgres (change postgres by mysql)
docker compose --profile prod run --rm dmpopidor sh -c 'ruby bin/docker postgres'
# Setup database
docker compose --profile prod run --rm dmpopidor sh -c 'ruby bin/docker db:setup'
# Run all services
docker compose --profile prod up -d
The rails server is launched via puma behind a niginx, it is accessible at the url http://localhost:8080
The tests are run by rswag, which generates OpenAPI documentation based on these tests.
An rswag command is defined in the Procfile.dev
file to generate the OpenAPI file.
You can generate the OpenAPI file and run the tests with the following command:
docker compose -f docker-compose.yml -f docker-compose-dev.yml --profile dev exec dmpopidor sh -c "RAILS_ENV=test rails rswag"
See the Troubleshooting Guide on the Wiki.
Issues should be reported here on Github Issues Please be advised though that we can only provide limited support for your local installations. Any security patches and bugfixes will be applied to the most recent version, and we will endeavour to support migrations to the current release.
If you would like to contribute to the project. Please follow these steps to submit a contribution:
See the Contribution Guide on the Wiki for more details.
The DMP Roadmap project uses the MIT License.