This repository contains the backend code for the Dutch exposure notification app.
- The backend is located in the repository you are currently viewing.
- The iOS app can be found here: https://github.com/minvws/nl-covid19-notification-app-ios
- The Android app can be found here: https://github.com/minvws/nl-covid19-notification-app-android
- The designs that are used as a basis to develop the apps can be found here: https://github.com/minvws/nl-covid19-notification-app-design
- The architecture that underpins the development can be found here: https://github.com/minvws/nl-covid19-notification-app-coordination
The core team works on the repository in a private fork (for reasons of compliance with existing processes) and will share its work as often as possible.
If you plan to make non-trivial changes, we recommend to open an issue beforehand where we can discuss your planned changes. This increases the chance that we might be able to use your contribution (or it avoids doing work if there are reasons why we wouldn't be able to use it).
Local development support is provided for all platforms - Windows, macOS, Linux - by ServerStandAlone - a .NET Core MVC Web App, and the command line apps in the Data Utilities folder.
- Visual Studio 2019 (or Rider)
- Your choice of SQL Server instances
- Or quickstart: only Docker
To quickly start a local Standalone development environment for app testing purposes you can use of the docker-compose file:
# Solution root
cd docker
docker-compose up --build
Please be aware of the 'quickstart development'-only semi-secrets in docker/**/*
, the Docker configuration has no intentions to be used in publicly available testing, acceptation or production environments.
First make sure that you have the following installed:
- Dotnet Core 3.1 SDK: https://dotnet.microsoft.com/download/dotnet-core/3.1
- Node JS 12.18.1+ with NPM: https://nodejs.org/en/
- Yarn: https://yarnpkg.com/
- Angular CLI: https://angular.io/guide/setup-local
- Optionally either Visual Studio or Rider.
- A terminal is recommended, if you're running an older windows then https://cmder.net/ is useful. You need gitbash.
Then clone this repo.
- Setup a database instance. Windows users can use a local SQL Server.
- Add an
appsettings.Development.json
file. This overrides the settings in appsettings.json. And add a value for the MSS connection string. - Go to the ServerStandAlone folder and run it with 'dotnet run'.
The ICC Portal consists of a .Net Core backend found under ICCBackend
and an Angular / ASP.Net MVC Core frontend found under ICCPortal
- Setup a database instance. Windows users can use a local SQL Server.
- Add an
appsettings.Development.json
file to the folderICCBackend
. This overrides the settings in appsettings.json. And add a value for the MSS connection string. - Go to the
\ICCBackend
folder and run it withdotnet run
, this will start the backend in Kestrel. - Access the APIs here:
http://localhost:5000/swagger/index.html
. - To provision the database you must execute
/devops/nukeandpavedb
in Swagger. - Done :)
- Clone this repo
- Open a terminal and go to
\ICCPortal\ClientApp
. - Run
yarn
to install all of the dependencies. - Run the frontend with
ng serve
. - The server API url can be configured in
ICCPortal\ClientApp\src\environments\environment.ts
- Done :)
The build and package pipeline for this project is implemented as a set of batch scripts. These scripts can be executed on a development machine without arguments or via a build server (Jenkins, Azure Devops) without the need to lock-in the build process to one specific vendor. This should also make it easier to build older versions of the server because all of the logic required to build is committed to version control.
To run the scripts you must have following installed and accessible in your path:
- 7zip
Here is an overview of our scripts:
Name | Description |
---|---|
build.bat | Builds all of the project in release mode |
and publishes packages into the folder | |
publish in the root of the solution. |
|
package.bat | Packages the published files as zip |
archives and puts them in publish . |
Some parts of this application are inspired by the work on Private Tracer. You can find their license here.