Local Development

To run the SampleWebApp you need to have a SQL Server running, this is temporary until we provide the remain database providers.

Using SQL Server on the root run docker-compose -f .\docker-compose.sqlServer.yml up

Run the Sample the database should be provisioned and properly setup its model.

Nox.Solution

Environment Variables for Sensitive Data

Do not commit or keep sensitive data on your yaml solution files.

The current way to this is by using Environment Variables.

Example

Nox will expand any text with the following convention ${{ env.VAR_NAME }} to the value of VAR_NAME Environment Variable if found. Sample Yaml:

databaseServer:
    name: SampleCurrencyDb
    serverUri: ${{ env.DB_SERVER }}
    provider: sqlServer
    port: 1433
    user: ${{ env.DB_USER }}
    password: ${{ env.DB_PASSWORD }}

Schemas Update

Until we automate this process whenever you change the Nox Solution you need: to run the test in > NoxSolutionSchemaGenerate. This test will generate the new schema files that needs to be also added to the commit. The CI pipeline will publish the new schemas.

Nox Types

a Domain driven type system for Nox solutions

ToString Conventions

Nox does not follow the usual convention for ToString().

The ToString() should return the same result independently of the current culture, for example for DateTime, Currency, dependent types.

The reasoning behind this is to ensure a fully predictable result that facilitates ETL process's and interopability with other systems.

The same is expected for the ToString(string format) overload.

If you need a culture dependent representation create an overload with a IFormatProvider parameter, example

ToString(IFormatProvider formatProvider);

LatLong Nox type example:

 public override string ToString()
{
    return $"{Value.Latitude.ToString("0.000000", CultureInfo.InvariantCulture)} {Value.Longitude.ToString("0.000000", CultureInfo.InvariantCulture)}";
}

public string ToString(IFormatProvider formatProvider)
{
    return $"{Value.Latitude.ToString(formatProvider)} {Value.Longitude.ToString(formatProvider)}";
}

Versioning

We are using SemVer for versioning our deliverables.

To manage this version we are using GitVersion tool.

Using it locally

You can use gitversion locally to test and setup configuration. To do that intall the dotnet tool dotnet tool install --global GitVersion.Tool --version 5.*

run dotnet-gitversion to see the current variables of git version

run dotnet-gitversion /updateprojectfiles to update csproject files

Release

Just Create a release in GitHub, tag it properly, and that is all. In the future we want to automate this process.