sancsoft / hq Goto Github PK

• Install and configure Entity Framework to class library
• Configure environment variable based configuration using connection builder to construct a connection string (in addition to supporting a connection string via config file) - for example DB_HOST, DB_NAME, DB_USER, etc.
• Setup dotnet tool manifest file to track tool version

Setup an authorization server using OpenIddict based on the ASP.Net Identity MVC template with customized layout and user self service portal.

It should support authentication using Sancsoft Azure AD for single sign-on for Sancsoft employees.

• Replace the MVC web project with an Angular project
• Configure OpenIdConnection (OIDC) authentication against KeyCloak auth server
• Research mechanism to generate API models from OpenAPI spec from API project, implement if reasonable
• Add runtime app settings
• Setup docker image with envsubst to generate runtime app settings from templated JSON
• Update platform-web GitHub actions workflow configuration
• A global route guard should be added to require authentication to access the interface

• Install and configure API versioning package
• API versioning should be used as a route parameter with the initial API version being v1

• Setup Keycloak platform source
• Create sancsoft Keycloak theme
• Create Docker image
• Add to GitHub actions workflow

Create a deployment folder with samples for deploying using a docker compose file with the public GHCR images that get built with GitHub actions.

Include a sample .env with insecure defaults to make it easy to try out the software.

Components

• PostgreSQL
• API
• Web
• KeyCloak

• Setup console platform project with support for Spectre.Console
• Setup a typed HttpClient to talk to HQ API
• Research mechanism to generate API models from OpenAPI spec from API project, implement if reasonable
• Configure a login command that uses OpenIdConnection (OIDC) authentication against KeyCloak auth server
  • The device code flow should be utilized
  • The offline_access scope should be requested, the refresh token and cached access token should be persisted
  • Configure a HTTP Message Handler that automatically handles the access token, consider using IdentityModel

Add a changelog file using https://keepachangelog.com/en/1.1.0/ as a template.

• Add a command for creating a client
• Add a command for reading a client by ID
• Add a command for listing clients
• Add a command for updating a client
• Add a command for deleting a client

Setup base project framework for development.

• .NET class library
• .NET API
• .NET Authorization server
• .NET tests
• .NET console app
• .NET console client
• Angular web client
• GitHub actions CI

• Update server projects from net6.0 to net8.0
• Bump third party packages to latest version
• Update GitHub actions workflows

Configure integration tests with test server, update CI and CD pipelines to run integration tests.

• Add a ClientService to manage clients
• Add a handler for creating a client
• Add a handler for reading a client by ID
• Add a handler for listing clients
• Add a handler for updating a client
• Add a handler for deleting a client
• Add integration tests to validate API

• Add IOptions<AuthorizationOptions> to hold authorization settings
• Configure API with JWT bearer configuration to use AuthorizationOptions to get auth server URL
• Configure Swagger with OIDC settings to allow easy testing

Add development, build and release instructions to readme file.