diff --git a/README.md b/README.md index a0c20df..48a9037 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@ +
+ DeltaBreed Logo +
+ +

+ This repo contains the docker-compose configurations used to run DeltaBreed. +

+ # Prereqs Docker and Docker-compose are both required. +# Architecture +The primary components of DeltaBreed are the Web UI (Breeding-Insight/bi-web) and the API (Breeding-Insight/bi-api). +The [BrAPI Java Server](https://github.com/plantbreeding/brapi-Java-TestServer) is used for phenotypic data storage, [Gigwa](https://github.com/SouthGreenPlatform/Gigwa2) is used for genotypic data storage, and interoperability with external applications such as [Field Book](https://github.com/PhenoApps/Field-Book/) is enabled by [BrAPI](https://brapi.org/). +DeltaBreed uses [ORCID](https://orcid.org/) for authentication. + +![DeltaBreed v1.0 architecture diagram.](./images/architecture.1.0.png) + # Configuration The containers are not run by the root user but by a new user and group called 'host'. The user and group ids for host are both set to 1001 by default. If diff --git a/images/DeltaBreed.svg b/images/DeltaBreed.svg new file mode 100644 index 0000000..a2b44b8 --- /dev/null +++ b/images/DeltaBreed.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/architecture.1.0.png b/images/architecture.1.0.png new file mode 100644 index 0000000..3271b41 Binary files /dev/null and b/images/architecture.1.0.png differ