nyss-platform-norcross / nyss

Welcome to the repository for the new community-based surveillance solution, called Nyss!

Nyss is a Norwegian word and means to "get the wind of something". The first Norwegian computer was called Nusse.

Nyss is a reimplementation of the previous CBS solution and proudly extending all the great work done there.

Getting started

How to run and develop everything on your local machine.

Prerequisites

• .NET Core Installer - SDK 3.1.100
• Azure Functions Core Tools
• Microsoft Azure Storage Emulator. Alternatively, especially if you are using mac/linux: Azurite
• Microsoft Azure Storage Explorer

Recommended tools

• IDE:
  • Visual Studio 2019 (and ReSharper)
  • Rider
  • Visual Studio Code
• Git client:
  • TortoiseGit(Windows only)
  • Fork
  • GitLens (Extension for VS code)
• Azure Data Studio or SQL Server Management Studio
• Service Bus Explorer (Windows only)

Run database migrations

• Make sure the connection string for NyssDatabase in appsettings.Development.json is correct. By default, a SQL Server Express LocalDB instance is used, which should work out of the box if you are using Visual Studio on Windows. On mac, an alternative can be to run SQL Server in in a docker container. (A nice guide)
• Ensure you have the ef core dotnet tool installed:

  dotnet tool install --global dotnet-ef

• Update the two data base contextes:

  dotnet ef database update --context NyssContext
  dotnet ef database update --context ApplicationDbContext

See Database and migrations for further details on working with the database.

Set up Blob storage

• Make sure that the Azure storage emulator is running, and open the emulator connection in Azure Storage Explorer.
• Open Microsoft Azure Storage Explorer and create the containers that are needed (they are listed in the AppSettings.json file in the Nyss.Web project):
  • sms-gateway
  • nyss-blob-container
  • nyss-agreements-container
• Create a new text file authorized-api-keys.txt with and upload it to the sms-gateway container.
• If you want to test sending emails locally, create a new text file whitelisted-email-addresses.txt with a list of email addresses that you want to use (separated by newline) and upload it to the sms-gateway container.
• If you want to test sending SMSes locally, create a new text file whitelisted-phone-numbers.txt with a list of email addresses that you want to use (separated by newline) and upload it to the sms-gateway container.

Add UserSecrets

In order to test everything locally, there are a couple of sensitive configuration variables that should be set. We store these as UserSecrets in order make them less prone to being checked in to our git repository. Most should work without these, but some parts of nyss uses some services that you can't run locally and therefore need a connection string, api key of some sort. You can find all keys values in the appsettings.json files. The most important ones to think of is:

• SERVICEBUS_CONNECTIONSTRING/ConnectionStrings.ServiceBus (in order to send service bus messages locally)
• MailConfig.Sendgrid.ApiKey (if you are going to test sending emails locally)

The user secrets file is the same for all running applications. How to access it:

• In VS2019, right-click either a FunctionApp or WebApp project, and click "Manage User Secrets".
• On Windows this file is normally located at %AppData%\Microsoft\UserSecrets\<user_secrets_id>\secrets.json
• On Linux/MacOs, it should be located here: ~/.microsoft/usersecrets/<user_secrets_id>/secrets.json (the user_secrets_id can be found in the .csproj files)

Run the web applications (RX.Nyss.Web and RX.Nyss.ReportApi)

• Naviagte to src/RX.Nyss.Web or src/RX.Nyss.ReportApi directory and in a terminal run dotnet run. The first build may take up to 5 minutes, the applicatiion is ready to open when you see Compiled Successfully! in the npm command prompt.
• Each application should open a browser window, or you can manually open https://localhost:5001/ (Web application) or https://localhost:5003/swagger (Report Api).
• A default login of System Administrator is [email protected] and a password is P@ssw0rd.

Run the function apps (RX.Nyss.FuncApp and RX.Nyss.ReportFuncApp)

• Naviagte to src/RX.Nyss.FuncApp or src/RX.Nyss.ReportFuncApp directory and in a terminal run func host start. References: Code and test Azure Functions locally

And you are done!

Some contribution notes

Code review checklist

• PR branch is on top of master
• Build and all unit tests are green (and business logic is covered by unit tests)
• The code fulfills the acceptance criteria
• The code is easy to understand or has substantial documentation on how to understand
• "How to test" steps should be applied and understandable for both tester and reviewer
• Test that it is working in dev once the PR is completed, merged to master and deployed
• The code is formatted according to code conventions
• If data model changes, ER diagram needs to be updated

Code conventions

• C# code style should be specified in the .editorconfig file in the repository root directory. Examples:
  • line length (and wrap)
  • public members on top
  • object initializers
  • usings

Git commit message style

• Git Commit Best Practices
• Commit often and push if you feel for it. Squash them if a lot of them doesn't add value
• Branch name format: feature or bugfix/workitem-number-workitem-name, eg:
  • feature/23-add-system-administrator
  • bugfix/73-add-missing-margins-in-project-dashboard
• Commit messages: Imperative style: Write what the code now does and not what the developer has done. Example:

# wrong
Added mapper, updated controller

# correct
Add validation rules for creating a supervisor
- Add mapper
- Update supervisor controller