From 58e71ff184cd7ab63065c929382c890ae7a9b33b Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Wed, 3 Feb 2021 16:42:57 +0100 Subject: [PATCH 1/4] readme: rm status section we do releases and had a security audit, so the warning is no longer acurate --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index 836f249f5..c3e8795de 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,6 @@ Castellum is a privacy-compliant subject database for scientific research. -## Status - -This project is still in development. There may be severe vulnerabilities -in the code. It is strongly recommended not to use this in production -yet. - ## Releases We typically release at the end of every 3 week sprint. See `CHANGES.md` -- GitLab From 863abbf80f916ac7e040184ecec04d8af688b3ef Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Wed, 3 Feb 2021 16:44:09 +0100 Subject: [PATCH 2/4] readme: mv development setup to docs/hacking.md In the readme it is easily confused for production installation instructions. --- README.md | 15 --------------- docs/hacking.md | 11 +++++++++++ 2 files changed, 11 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index c3e8795de..dce31b062 100644 --- a/README.md +++ b/README.md @@ -11,21 +11,6 @@ for recent changes. Tagged snapshots of the code are available from docker images that already contain most dependencies are available from `registry.git.mpib-berlin.mpg.de/castellum/castellum`. -## Development - -The following commands will install everything and start a local testserver (on ubuntu): - - sudo apt install python3-pip python3-venv npm make docker-compose gettext gdal-bin python3-psycopg2 - cd castellum - make install_githooks - make # start castellum - -You can login with user "admin" and password "password". - -## Testing - -The command `pytest` will execute all tests. (postgres needs to be running) - ## Links - Project home page: https://www.mpib-berlin.mpg.de/research-data/castellum diff --git a/docs/hacking.md b/docs/hacking.md index 0e6c5b25f..5ba27403c 100644 --- a/docs/hacking.md +++ b/docs/hacking.md @@ -1,3 +1,14 @@ +## Development setup + +The following commands will install everything and start a local testserver (on ubuntu): + + sudo apt install python3-pip python3-venv npm make docker-compose gettext gdal-bin python3-psycopg2 + cd castellum + make install_githooks + make # start castellum + +You can login with user "admin" and password "password". + # Things to be aware of when working on the castellum code - We assume a general familiarity with django, especially its -- GitLab From 0e7d584926cb609897c15e732e58325807e71d90 Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Wed, 3 Feb 2021 16:55:24 +0100 Subject: [PATCH 3/4] readme: integrate releases into links --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index dce31b062..82c70c037 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,12 @@ Castellum is a privacy-compliant subject database for scientific research. -## Releases - -We typically release at the end of every 3 week sprint. See `CHANGES.md` -for recent changes. Tagged snapshots of the code are available from -. Tagged -docker images that already contain most dependencies are available from -`registry.git.mpib-berlin.mpg.de/castellum/castellum`. - ## Links - Project home page: https://www.mpib-berlin.mpg.de/research-data/castellum - Source code: https://git.mpib-berlin.mpg.de/castellum/castellum/ -- Documentation: https://castellum.mpib.berlin/documentation/en/ +- Releases: https://git.mpib-berlin.mpg.de/castellum/castellum/-/releases +- Docker: `registry.git.mpib-berlin.mpg.de/castellum/castellum` +- End-user documentation: https://castellum.mpib.berlin/documentation/en/ +- Developer documentation: https://git.mpib-berlin.mpg.de/castellum/castellum/-/tree/main/docs - Code of conduct: https://www.mpg.de/11961177/code-of-conduct-en.pdf -- GitLab From 0585b96c368da170387732c5cf11323bdb047112 Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Wed, 3 Feb 2021 16:55:58 +0100 Subject: [PATCH 4/4] expand description of castellum --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 82c70c037..ecf738b91 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ # Castellum -Castellum is a privacy-compliant subject database for scientific -research. +Castellum is a subject database system developed at the Max Planck +Society. Its main goals are: + +- GDPR compliant data protection and security +- Flexibility so it can be used in different organisations + +## Features + +- **Subject management**: Castellum is a central place to collect + references to all data related to a subject, e.g. so it can be + deleted on request +- **Pseudonym service**: Contact details are stored in Castellum so + all other databases can work with pseudonyms instead. +- **Recruitment**: Castellum allows you to find potential subjects + from an existing pool using study specific filters +- **Appointments**: You can manage appointments for test sessions. ## Links -- GitLab