README.md

Achtung: Bitte Milestone Simulation mit oberster Priorität abarbeiten!!

Für Simulations-Features (sofern nicht generell gültig) Branch 'Pilot' nutzen.

• Demo
• Swagger API
• Video pitch

Dieses Projekt entstand im Rahmen des #WirvsVirus-Hackathon.

• Organization - Google Docs
• DevPost submission
• Mit freundlicher Unterstützung von https://covidmeldeprozess.de/

Development

Prod

Dev

Pilot

General Guidelines

DO NOT COMMIT TO MASTER

Development happens in dev using feature branches and PR. dev branch is deployed at:

• Staging Deployment
• Staging API

Tech Stack

• Backend: Spring Boot
• Frontend: Vue.js
• Persistence: PostgreSQL
• Deployment: Google Kubernetes Engine (GKE)

How to run this server?

1. Install Docker
   • Linux: https://docs.docker.com/install/
     • Docker Compose has to be installed as well; see https://docs.docker.com/compose/install/
   • Mac : https://docs.docker.com/docker-for-mac/install/
   • Windows:
     • Pro/Enterprise: https://docs.docker.com/docker-for-windows/install/
     • Home: https://docs.docker.com/toolbox/toolbox_install_windows/
2. Run docker-compose up

Local development setup

Requirements

1. JDK 11 (Java)
   • https://adoptopenjdk.net/
   • Make sure your $JAVA_PATH environment variable is set correctly!
2. Gradle
   • https://gradle.org/install/
3. Python 3
   • https://www.python.org/downloads/
   • Make sure python3 can be found on $PATH!
4. YARN (Frontend-only)
   • https://classic.yarnpkg.com/en/docs/install

Preconditions

• Start PostgreSQL:
  • Using docker container: docker-compose up -d postgres
  • Alternatively: Manually start postgres and add a user as specified in server/src/main/resources/application.yml

Run full application

1. Make sure all preconditions have been met
2. Run ./gradlew run

Spring Boot Server

Make sure all preconditions have been met

• Using Gradle
  • Download Gradle wrapper gradle wrapper
  • Build application ./gradlew build
  • Test application ./gradlew test
  • Run server application ./gradlew run
• Using Intellij:
  • Import Project by opening the build.gradle file. Intellij resolves all dependencies and you can run the application by pressing the run button.

Frontend (more)

1. Make sure all preconditions have been met
2. Start local development server for vue.js development: ./gradlew runFrontendDev
   • The local development server still needs the server application to be running for REST API calls!

CI system

All commits to dev, master, feature/* and all PRs will be CI checked.

New commit to dev will result in new release to staging.imis-prototyp.de.

A new release to imis-prototyp.de is not triggerd by commit on master but by a new release tag.