Skip to content

leibniz-psychology/datawiz2

Repository files navigation

DataWiz - Research Data Documentation Assistant

Symfony Version PHP Version Composer Version Nodejs Version MySql Version DataWiz 2 Build Übersetzungsstatus

DataWiz helps Psychologist with their research documentation. As web based system DataWiz is free to use by anyone and contributions are welcome. More details of how to use DataWiz and how to contribute can be found at our homepage.

State of this project

This is the second iteration of the DataWiz application.
For today, you can't use this code in production and changes will occur.
You can find and test the latest version of Datawiz 2 (currently in beta) here.

Supported development environments

If you use macos or ubuntu you should have no problems, because those operating systems are used by the main contributors. For those who want to use windows, please consider running Windows Subsystem For Linux (WSL). While there is no intention to maintain any windows specific configuration from our side, you are still welcome to contribute and maintain those changes.

Development setup

To start developing you will need a local installation of php, composer, nodejs (and yarn), make, core utils, awk and the symfony cli. Please consider our recommended versions, if you encounter any problems running a development instance of DataWiz.

Githooks

To enable the custom project githooks run:

git config core.hooksPath .githooks

Deployment

DataWiz depends on multiple vendors.

  • All metadata is stored in a MySql/MariaDB.
  • The Single Sign On requires a running Keycloak.

A full production deployment is therefore a complicated process, which is beyond the scope of this repository. If you still wish to deploy DataWiz yourself, please contact our IT-Service department for further information and available resources. Consider before your deployment, that we offer a production instance free of charge under our product portfolio.

Moderation

To enable the moderation for yourself, add your email address in src/Controller/UserController.php. Afterwards, log into Datawiz as a normal user and navigate to <url>/admin/install in your browser. You should now have admin rights.

How to get help?

If you are new to the codebase, there are multiple resources provided for you to learn.

  • Many decision made within development are explained and/or discussed within our issue pages.
  • The most important concepts are explained in the projects' wiki page.