If you wish to work on the din-api project, you'll first need the .NET Core 2.2 SDK installed on your machine.
Required setup commands
dotnet restore
dotnet build
Secrets
All secrets used within the din-api project are stored in vault. To access these secrets either a github access token or application id-secret pair is needed. The application will decide on runtime which one to use depending on the environment.
Database
This project makes use of the FluentMigrator package.
A local database instance is needed for develment. The connection string to connect to this database instance is stored within the application.json
file. The local database instance can be iniated using the commands provided by the FluentMigrator CLI Tool
.
Instalation
dotnet tool install -g FluentMigrator.DotNet.Cli
Migrate
dotnet fm migrate -p mysql -c "connection string" -a "migration assembly"
Rollback
dotnet fm rollback -p mysql -c "connection string" -a "migration assembly"
Environment variables
Name | Value | Environment | Description |
---|---|---|---|
VAULT_URL | https://vault.naebers.net | All | The url to the secret management system (vault). |
VAULT_GITHUB_AT | string |
Development | The developers github access token to access the vault secrets. |
VAULT_ID | string |
Production | The application ID to access the vault secrets. |
VAULT_SECRET | string |
Production | The application SECRET to access the vault secrets. |