APSIM Registration System

Overview

This repository contains the APSIM registration platform, split across a shared library, a Web API, a Blazor web application, and tests.

Solution Structure

• RegistrationShared: Shared enums and models used by both API and web app.
• RegistrationWebAPI: ASP.NET Core minimal API for registration data and related workflows.
• RegistrationWebApp: Blazor Server UI for registration and admin workflows.
• Tests: Automated tests for API behavior and integration points.

Project Hierarchy

APSIM.RegistrationSystem/
├── RegistrationShared/          (Shared Models & Enums)
│   ├── Enums/
│   │   ├── AnnualTurnover.cs
│   │   ├── LicencePathway.cs
│   │   ├── OrganisationLicenceStatus.cs
│   │   └── UserLicenceStatus.cs
│   └── Models/
│       ├── Organisation.cs
│       └── User.cs
│
├── RegistrationWebAPI/          (Backend API)
│   ├── Data/                    (EF Core Entities & DbContext)
│   ├── Models/                  (Request/Response DTOs)
│   ├── Utilities/               (Helper Classes)
│   ├── Migrations/              (EF Core Migrations)
│   └── Program.cs               (API Configuration)
│
├── RegistrationWebApp/          (Blazor UI)
│   ├── Components/
│   │   ├── Pages/               (Routable Pages)
│   │   ├── Layout/              (Layout Components)
│   │   ├── LayoutObjects/       (Reusable UI Blocks)
│   │   ├── Utilities/           (Service Classes)
│   │   └── Classes/             (Domain Models)
│   ├── Properties/              (Launch Settings)
│   ├── wwwroot/                 (Static Assets)
│   ├── App.razor                (Root Component)
│   └── Program.cs               (App Configuration)
│
└── Tests/                       (Unit & Integration Tests)

Quick Start

Prerequisites

• .NET SDK 10.0 (matching project target framework net10.0)

Restore Dependencies

From the repository root:

dotnet restore RegistrationSystem.sln

Build

dotnet build RegistrationSystem.sln

Run the Web API

dotnet run --project RegistrationWebAPI/RegistrationWebAPI.csproj

Run the Web App (Standard)

Use this when you want a normal app run without file watching:

dotnet run --project RegistrationWebApp/RegistrationWebApp.csproj

Run the Web App (Watch / Hot Reload)

Use watch mode during UI development so changes are picked up automatically and hot reload is applied when possible:

dotnet watch run --project RegistrationWebApp/RegistrationWebApp.csproj

Run Watch Mode from VS Code Task Menu

You can start the same watch workflow from the VS Code terminal menu:

1. Open VS Code in this repository.
2. Select Terminal from the top menu.
3. Choose Run Task....
4. Select Just Watch RegistrationWebApp.

This starts the configured task that runs the web app in watch mode from the RegistrationWebApp project directory.

Run Tests

dotnet test Tests/Tests.csproj

Docker

You can run the API and web app locally with Docker or Docker Compose.

Build Images

From the repository root:

docker build -f RegistrationWebAPI/Dockerfile -t apsim-registration-webapi .
docker build -f RegistrationWebApp/Dockerfile -t apsim-registration-webapp .

Run With Docker Compose

Start both services together:

docker compose up -d --build

This starts:

• Web API at http://localhost:8088
• Web App at http://localhost:8089

Stop Docker Compose

docker compose down

Web App Pages

The RegistrationWebApp consists of the following routable pages:

Page	Route	Purpose
Home	/	Product selection and overview
Register	/register/{productId?}	Registration form with licence pathway selection
Download	/download	Download APSIM with registration validation
Validate	/validate	Validate download access for APSIM Classic
SpecialRegistration	/special	Special use registration form
Admin	/admin	Admin dashboard for viewing registrations
Error	/error	Error display page
NotFound	(implicit 404)	Page not found handler

API Endpoints

The RegistrationWebAPI provides RESTful endpoints:

• Authentication: POST /api/auth/token - Get JWT token
• Health: GET /health - API health check
• Registrations: GET/POST /api/registrations - List and create registrations
• Users: User management endpoints
• Organisations: Organisation management endpoints
• Downloads: Download audit and access tracking

See RegistrationWebAPI README for detailed endpoint documentation.

Project Documentation

For project-specific configuration, troubleshooting, and development details, see each project README linked above.

Contributing

1. Create a feature branch from master.
2. Make and validate your changes locally.
3. Open a pull request with a summary of what changed and why.