thomas.nuyken/vegasco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

New Angular based web version #1

Closed
thomas.nuyken wants to merge 150 commits from main into ddd
pull from: main
merge into: thomas.nuyken:ddd
Conversation 0 Commits 150 Files Changed 165 +15 -6
1 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit ff2707a0e8 - Show all commits

21
README.md
View File

@@ -1,17 +1,17 @@
# Vegasco Server # Vegasco Server
Backend for the vegasco (***VE***hicle ***GAS*** ***CO***nsumption) application. Backend for the vegasco (**VE**hicle **GAS** **CO**nsumption) application.
## Getting Started ## Getting Started
### Configuration ### Configuration
| Configuration | Description | Default | Required | | Configuration | Description | Default | Required |
|--------------------------|-------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|----------| |--------------------------|---------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|----------|
| JWT:MetadataUrl | The oidc meta data url | - | true | | JWT:MetadataUrl | The oidc meta data url | - | true |
| JWT:ValidAudience | The valid audience of the JWT token. | - | true | | JWT:ValidAudience | The valid audience of the JWT token. | - | true |
| JWT:NameClaimType | The claim type of the user's name claim. | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name | false | | JWT:NameClaimType | The claim type of the user's name claim. For keycloak, using `preferred_username` is often the better choice. | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name | false |
| JWT:AllowHttpMetadataUrl | Whether to allow the meta data url to have http as protocol. Always true when `ASPNETCORE_ENVIRONMENT=true` | false | false | | JWT:AllowHttpMetadataUrl | Whether to allow the meta data url to have http as protocol. Always true when `ASPNETCORE_ENVIRONMENT=true` | false | false |
The application uses the prefix `Vegasco_` for environment variable names. The prefix is removed when the application reads the environment variables and duplicate entries are overwritten by the environment variables. The application uses the prefix `Vegasco_` for environment variable names. The prefix is removed when the application reads the environment variables and duplicate entries are overwritten by the environment variables.
@@ -56,3 +56,12 @@ As appsettings.json (or a environment specific appsettings.*.json):
} }
} }
``` ```
### Running the application
The solution uses Aspire to orchestrate the application. Specifically, it introduces sensible service defaults, including but not limited to OpenTelemetry,
creates a Postgres database as a docker container, and starts the WebApi with the correct configuration to communicate with the database.
Ensure you have an identity provider set up, for example Keycloak, and configured the relevant options described above.
Then, to run the application, ensure you have Docker running, then run the `Vegasco.Server.AppHost` launch profile.