getting-started.md

hide:

- navigation

Getting Started

!!! abstract "Abstract"

In this short getting started guide we show the dependencies to run the database repository and perform a small, 
local, test deployment for quickly trying out the features that the repository offers.

Requirements

Hardware

For this small, local, test deployment any modern hardware would suffice, we recommend a machine with at least:

• 8 Cores (can be virtual cores)
• 16GB RAM
• 100GB SSD memory
• Fast internet connection

Software

Install :fontawesome-brands-docker: Docker Engine for your OS.

Deployment

We currently maintain 14 images on Dockerhub.

=== ":fontawesome-brands-linux: Linux"

Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml) 
and [`.env`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example) 

    $ curl -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml
    $ curl -o .env https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example

Start the services

    $ docker-compose up -d

=== ":fontawesome-brands-apple: macOS"

Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml) 
and [`.env`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example) 

    $ curl -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml
    $ curl -o .env https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example

Start the services

    $ docker-compose up -d

The system is auto-configured for a small, local, test deployment. You need to place the .env file in the same directory as the docker-compose.yml.

Development

We invite all open-source developers to help us fixing bugs and introducing features to the source code. Get involved by sending a mail to Prof. Andreas Rauber and Projektass. Martin Weise. Clone the repository and create a feature branch from dev and implement your changes.

Software

We develop all packages with the following software requirements:

1. Java OpenJDK 11
2. Maven 3.0.0+
3. Node.js 14+
4. Yarn 1.21.0+
5. Postgres 12+
6. MariaDB 10+

Building

For local development you need to install the entities from the metadata database and the general DTOs that are exchanged between the services by installing the package:

mvn -f ./fda-metadata-db/pom.xml clean install

All other services depend on this package. You have to build them later:

mvn -f ./fda-container-service/pom.xml clean package -DskipTests
...

Conviniently, you can build them all through make:

make build-backend