Skip to content

RadarCOVID/radar-covid-backend-notifyme-server

Repository files navigation

RadarCOVID NotifyMe Fork

Fork from NotifyMe SDK Backend with the following changes:

  • Functional:

    • When a venue gets a case code by health authorities, owner must set the code in the web application and upload their private QR.
    • Web application will check the case code. If it's valid, check service will return a token and code will be redeemed.
    • Web application will connect to this service (NotifyMe Server) with the JWT and trace keys.

    You can find these changes in this package.

  • Technical:

    • OpenAPI generation using springdoc-openapi.
    • Upgraded versions (PostgreSQL, Tomcat,...).
    • Degraded Spring Boot to 2.3.x version for AWS compatibility.

Installation and Getting Started

Building from Source

To build the project, you need to run this command:

mvn clean package -P <environment>

Where <environment> has these possible values:

  • radarcovid-local. To run the application from local (eg, from IDE o from Maven using mvn spring-boot:run). It is the default profile, using application.yaml configuration file. If any properties need to be modified, you can create application-radarcovid-local.yml configuration file.
  • radarcovid-docker. To run the application in a Docker container with docker-compose, using application.yaml configuration file. If any properties need to be modified, you can create application-docker.yml configuration file.
  • radarcovid-pre. To run the application in the Preproduction environment. Preproduction environment properties are configured in the infrastructure.
  • radarcovid-pro. To run the application in the Production environment. Production environment properties are configured in the infrastructure.

The project also uses Maven profile aws-env to include dependencies when it is running on AWS environment, so the compilation command for Preproduction and Production environments would be:

mvn clean package -P radarcovid-pre,aws-env
mvn clean package -P radarcovid-pro,aws-env

All profiles will load the default configuration.

Application uses The Twelve-Factor App - Config approach so configuration is stored in environment variables.

Support and Feedback

The following channels are available for discussions, feedback, and support requests:

Type Channel
Issues

Contribute

If you want to contribute with this exciting project follow the steps in How to create a Pull Request in GitHub.

More details in CONTRIBUTING.md.

License

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.

Releases

No releases published

Packages

No packages published