Compare commits
5 Commits
1daf7a5b59
...
feat/29-bf
| Author | SHA1 | Date | |
|---|---|---|---|
| 2780bce4fd | |||
| 7d67ecbde1 | |||
| dfbaf7640a | |||
| 364d2eceb2 | |||
| c746648e5c |
27
.gitignore
vendored
Normal file
27
.gitignore
vendored
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# .NET build output
|
||||||
|
bin/
|
||||||
|
obj/
|
||||||
|
[Dd]ebug/
|
||||||
|
[Rr]elease/
|
||||||
|
*.user
|
||||||
|
|
||||||
|
# Test results / coverage
|
||||||
|
[Tt]est[Rr]esults/
|
||||||
|
*.trx
|
||||||
|
coverage*.json
|
||||||
|
coverage*.xml
|
||||||
|
*.coverage
|
||||||
|
|
||||||
|
# Rider / VS / VS Code
|
||||||
|
.idea/
|
||||||
|
.vs/
|
||||||
|
.vscode/
|
||||||
|
|
||||||
|
# Node / Angular (added as the frontend lands)
|
||||||
|
node_modules/
|
||||||
|
dist/
|
||||||
|
.angular/
|
||||||
|
|
||||||
|
# OS
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
41
BACKLOG.md
41
BACKLOG.md
@@ -12,22 +12,41 @@ Each slice is **independently demoable** and meets the Definition of Done in `CL
|
|||||||
|
|
||||||
## Iteration 0 — Foundations *(milestone: `Iteration 0 — Foundations`)*
|
## Iteration 0 — Foundations *(milestone: `Iteration 0 — Foundations`)*
|
||||||
|
|
||||||
### S-00 · Repository skeleton, Gitea Actions CI, contributor workflow
|
> **S-00 was split** (CLAUDE.md §13) into the sub-slices below. The original
|
||||||
|
> outcome — a fresh clone + `docker compose up` reaching a green BFF health
|
||||||
|
> endpoint, with CI green and the contributor scaffolding in place — is the sum
|
||||||
|
> of S-00-a…e. The Gitea milestones, labels, and slice issues already exist —
|
||||||
|
> they are managed directly with the `tea` CLI.
|
||||||
|
|
||||||
**Outcome:** A fresh `git clone` from the Respellion Gitea remote, followed by `docker compose up`, produces a green "hello world" health endpoint from a placeholder BFF. Gitea Actions runs lint, build, unit tests, and the compose-up smoke test, all green. Issue templates, PR template, milestones, labels, and the first project board exist in Gitea.
|
### S-00-a · Placeholder BFF + health endpoint
|
||||||
|
|
||||||
**Acceptance:**
|
**Outcome:** A minimal .NET BFF exposing `GET /health` returning green; runnable with `dotnet run`. TDD anchor for the slice.
|
||||||
|
|
||||||
- New developer follows `README.md` and reaches a green local environment in under 10 minutes.
|
**Touches:** `services/bff/`, tests. **Out of scope:** Docker, CI, OIDC.
|
||||||
- Gitea Actions pipeline green on `main`.
|
|
||||||
- `git-cliff` produces an empty `CHANGELOG.md`.
|
|
||||||
- `docs/PRD.md`, `CLAUDE.md`, `BACKLOG.md`, `docs/architecture/adr-0001-loose-coupling.md`, `docs/gitea-workflow.md` all in repo.
|
|
||||||
- `.gitea/workflows/ci.yaml`, `.gitea/ISSUE_TEMPLATE/{slice,bug,adr-proposal}.md`, `.gitea/PULL_REQUEST_TEMPLATE.md` all in repo.
|
|
||||||
- Gitea milestone `Iteration 1 — Walking Skeleton` exists, populated with issues S-01 through S-09.
|
|
||||||
|
|
||||||
**Touches:** repo layout, Gitea Actions workflows, Dockerfile for placeholder BFF, `docker-compose.yml` skeleton, MkDocs scaffold, Gitea issue/PR templates.
|
### S-00-b · Dockerfile + compose skeleton + compose-up smoke
|
||||||
|
|
||||||
**Out of scope:** any business logic, frontend, OpenZaak.
|
**Outcome:** BFF containerized; `infra/docker-compose.yml` brings it up; health green within 3 minutes from a fresh clone.
|
||||||
|
|
||||||
|
**Touches:** `services/bff/Dockerfile`, `infra/docker-compose.yml`, smoke script. **Out of scope:** other services, CI.
|
||||||
|
|
||||||
|
### S-00-c · Gitea Actions CI (lint, build, unit, compose-up smoke)
|
||||||
|
|
||||||
|
**Outcome:** `.gitea/workflows/ci.yaml` green on PRs and `main`: lint, build, unit, compose-up smoke. Actions pinned by absolute URL (§8.7/§15).
|
||||||
|
|
||||||
|
**Touches:** `.gitea/workflows/ci.yaml`, `docs/runbooks/ci.md`. **Out of scope:** mutation, e2e, container push.
|
||||||
|
|
||||||
|
### S-00-d · Contributor workflow: issue/PR templates, git-cliff, CHANGELOG
|
||||||
|
|
||||||
|
**Outcome:** Issue templates (`slice`/`bug`/`adr-proposal`), PR template, `git-cliff` → empty `CHANGELOG.md`, `docs/gitea-workflow.md`.
|
||||||
|
|
||||||
|
**Touches:** `.gitea/ISSUE_TEMPLATE/`, `.gitea/PULL_REQUEST_TEMPLATE.md`, `cliff.toml`, `CHANGELOG.md`, `docs/gitea-workflow.md`. **Out of scope:** app code.
|
||||||
|
|
||||||
|
### S-00-e · Docs scaffold: MkDocs + ADR-0001 + README quickstart
|
||||||
|
|
||||||
|
**Outcome:** MkDocs builds the `docs/` site; `docs/architecture/adr-0001-loose-coupling.md` exists; README has a sub-10-minute quickstart.
|
||||||
|
|
||||||
|
**Touches:** `mkdocs.yml`, `docs/` nav, `docs/architecture/adr-0001-loose-coupling.md`, `README.md`. **Out of scope:** Gitea Pages publish.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -56,6 +56,15 @@ docker compose -f infra/docker-compose.yml up -d
|
|||||||
|
|
||||||
Health checks should be green within ~3 minutes on a developer machine. If something fails, see [docs/runbooks/local-startup.md](docs/runbooks/local-startup.md).
|
Health checks should be green within ~3 minutes on a developer machine. If something fails, see [docs/runbooks/local-startup.md](docs/runbooks/local-startup.md).
|
||||||
|
|
||||||
|
> **Wired today (Iteration 0):** only the placeholder BFF is in `infra/docker-compose.yml` so far. Bring it up and smoke-test its health endpoint:
|
||||||
|
>
|
||||||
|
> ```bash
|
||||||
|
> docker compose -f infra/docker-compose.yml up -d --build --wait
|
||||||
|
> curl http://localhost:8080/health # -> Healthy
|
||||||
|
> ```
|
||||||
|
>
|
||||||
|
> `--wait` exits non-zero unless the container reports healthy, so this doubles as the compose-up smoke test. The remaining services and the URLs below land in later slices.
|
||||||
|
|
||||||
**Default URLs**
|
**Default URLs**
|
||||||
|
|
||||||
| Service | URL |
|
| Service | URL |
|
||||||
|
|||||||
@@ -85,7 +85,7 @@ The five flows form the BDD acceptance backbone (Gherkin scenarios in `tests/acc
|
|||||||
|
|
||||||
- **Source control & collaboration:** **Gitea** (Respellion self-hosted) — repository, issues, milestones, labels, projects, releases, container registry, wiki, packages.
|
- **Source control & collaboration:** **Gitea** (Respellion self-hosted) — repository, issues, milestones, labels, projects, releases, container registry, wiki, packages.
|
||||||
- **CI/CD:** **Gitea Actions** running on Respellion-hosted `act_runner` instances. Workflow files live in `.gitea/workflows/`. Marketplace actions are referenced via absolute URLs (`uses: https://github.com/actions/checkout@v4` or Gitea-hosted equivalents where available) for reproducibility.
|
- **CI/CD:** **Gitea Actions** running on Respellion-hosted `act_runner` instances. Workflow files live in `.gitea/workflows/`. Marketplace actions are referenced via absolute URLs (`uses: https://github.com/actions/checkout@v4` or Gitea-hosted equivalents where available) for reproducibility.
|
||||||
- **Backend:** .NET 9 (LTS at iteration time), C#, minimal APIs for BFF, MediatR for in-process messaging within Domain Service, EF Core for the projection store and domain DB.
|
- **Backend:** .NET 10 (LTS at iteration time), C#, minimal APIs for BFF, MediatR for in-process messaging within Domain Service, EF Core for the projection store and domain DB.
|
||||||
- **Frontend:** Angular (latest LTS) + TypeScript, standalone components + signals, Nx monorepo, NL Design System component library, Angular Testing Library + Playwright.
|
- **Frontend:** Angular (latest LTS) + TypeScript, standalone components + signals, Nx monorepo, NL Design System component library, Angular Testing Library + Playwright.
|
||||||
- **Workflow:** Flowable (BPMN + DMN) via Docker image; Postgres for engine store.
|
- **Workflow:** Flowable (BPMN + DMN) via Docker image; Postgres for engine store.
|
||||||
- **Identity:** Keycloak with pre-seeded realms.
|
- **Identity:** Keycloak with pre-seeded realms.
|
||||||
|
|||||||
6
global.json
Normal file
6
global.json
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"sdk": {
|
||||||
|
"version": "10.0.203",
|
||||||
|
"rollForward": "latestFeature"
|
||||||
|
}
|
||||||
|
}
|
||||||
19
infra/docker-compose.yml
Normal file
19
infra/docker-compose.yml
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Local development stack. Grows service-by-service with each slice.
|
||||||
|
# S-00-b: the placeholder BFF with a /health check.
|
||||||
|
#
|
||||||
|
# docker compose -f infra/docker-compose.yml up -d --build --wait
|
||||||
|
# curl http://localhost:8080/health # -> Healthy
|
||||||
|
services:
|
||||||
|
bff:
|
||||||
|
build:
|
||||||
|
context: ../services/bff
|
||||||
|
dockerfile: Dockerfile
|
||||||
|
image: register-referentie/bff:dev
|
||||||
|
ports:
|
||||||
|
- "8080:8080"
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD", "curl", "-fsS", "http://localhost:8080/health"]
|
||||||
|
interval: 5s
|
||||||
|
timeout: 3s
|
||||||
|
retries: 5
|
||||||
|
start_period: 10s
|
||||||
3
services/bff/.dockerignore
Normal file
3
services/bff/.dockerignore
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
**/bin
|
||||||
|
**/obj
|
||||||
|
**/*.user
|
||||||
9
services/bff/Bff.Api/Bff.Api.csproj
Normal file
9
services/bff/Bff.Api/Bff.Api.csproj
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
<Project Sdk="Microsoft.NET.Sdk.Web">
|
||||||
|
|
||||||
|
<PropertyGroup>
|
||||||
|
<TargetFramework>net10.0</TargetFramework>
|
||||||
|
<Nullable>enable</Nullable>
|
||||||
|
<ImplicitUsings>enable</ImplicitUsings>
|
||||||
|
</PropertyGroup>
|
||||||
|
|
||||||
|
</Project>
|
||||||
12
services/bff/Bff.Api/Program.cs
Normal file
12
services/bff/Bff.Api/Program.cs
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
var builder = WebApplication.CreateBuilder(args);
|
||||||
|
builder.Services.AddHealthChecks();
|
||||||
|
|
||||||
|
var app = builder.Build();
|
||||||
|
|
||||||
|
app.MapGet("/", () => "BFF placeholder");
|
||||||
|
app.MapHealthChecks("/health");
|
||||||
|
|
||||||
|
app.Run();
|
||||||
|
|
||||||
|
// Exposed so the test host (WebApplicationFactory<Program>) can boot the app.
|
||||||
|
public partial class Program;
|
||||||
23
services/bff/Bff.Api/Properties/launchSettings.json
Normal file
23
services/bff/Bff.Api/Properties/launchSettings.json
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://json.schemastore.org/launchsettings.json",
|
||||||
|
"profiles": {
|
||||||
|
"http": {
|
||||||
|
"commandName": "Project",
|
||||||
|
"dotnetRunMessages": true,
|
||||||
|
"launchBrowser": true,
|
||||||
|
"applicationUrl": "http://localhost:5249",
|
||||||
|
"environmentVariables": {
|
||||||
|
"ASPNETCORE_ENVIRONMENT": "Development"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"https": {
|
||||||
|
"commandName": "Project",
|
||||||
|
"dotnetRunMessages": true,
|
||||||
|
"launchBrowser": true,
|
||||||
|
"applicationUrl": "https://localhost:7106;http://localhost:5249",
|
||||||
|
"environmentVariables": {
|
||||||
|
"ASPNETCORE_ENVIRONMENT": "Development"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
8
services/bff/Bff.Api/appsettings.Development.json
Normal file
8
services/bff/Bff.Api/appsettings.Development.json
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"Logging": {
|
||||||
|
"LogLevel": {
|
||||||
|
"Default": "Information",
|
||||||
|
"Microsoft.AspNetCore": "Warning"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
9
services/bff/Bff.Api/appsettings.json
Normal file
9
services/bff/Bff.Api/appsettings.json
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"Logging": {
|
||||||
|
"LogLevel": {
|
||||||
|
"Default": "Information",
|
||||||
|
"Microsoft.AspNetCore": "Warning"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"AllowedHosts": "*"
|
||||||
|
}
|
||||||
26
services/bff/Bff.Tests/Bff.Tests.csproj
Normal file
26
services/bff/Bff.Tests/Bff.Tests.csproj
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
|
||||||
|
<PropertyGroup>
|
||||||
|
<TargetFramework>net10.0</TargetFramework>
|
||||||
|
<ImplicitUsings>enable</ImplicitUsings>
|
||||||
|
<Nullable>enable</Nullable>
|
||||||
|
<IsPackable>false</IsPackable>
|
||||||
|
</PropertyGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<PackageReference Include="coverlet.collector" Version="6.0.4" />
|
||||||
|
<PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="10.0.8" />
|
||||||
|
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
|
||||||
|
<PackageReference Include="xunit" Version="2.9.3" />
|
||||||
|
<PackageReference Include="xunit.runner.visualstudio" Version="3.1.4" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<Using Include="Xunit" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<ProjectReference Include="..\Bff.Api\Bff.Api.csproj" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
</Project>
|
||||||
20
services/bff/Bff.Tests/HealthEndpointTests.cs
Normal file
20
services/bff/Bff.Tests/HealthEndpointTests.cs
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
using System.Net;
|
||||||
|
using Microsoft.AspNetCore.Mvc.Testing;
|
||||||
|
|
||||||
|
namespace Bff.Tests;
|
||||||
|
|
||||||
|
public class HealthEndpointTests(WebApplicationFactory<Program> factory)
|
||||||
|
: IClassFixture<WebApplicationFactory<Program>>
|
||||||
|
{
|
||||||
|
[Fact]
|
||||||
|
public async Task Health_endpoint_returns_200_and_reports_healthy()
|
||||||
|
{
|
||||||
|
var client = factory.CreateClient();
|
||||||
|
|
||||||
|
var response = await client.GetAsync("/health");
|
||||||
|
|
||||||
|
Assert.Equal(HttpStatusCode.OK, response.StatusCode);
|
||||||
|
var body = await response.Content.ReadAsStringAsync();
|
||||||
|
Assert.Contains("Healthy", body);
|
||||||
|
}
|
||||||
|
}
|
||||||
4
services/bff/Bff.slnx
Normal file
4
services/bff/Bff.slnx
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
<Solution>
|
||||||
|
<Project Path="Bff.Api/Bff.Api.csproj" />
|
||||||
|
<Project Path="Bff.Tests/Bff.Tests.csproj" />
|
||||||
|
</Solution>
|
||||||
30
services/bff/Dockerfile
Normal file
30
services/bff/Dockerfile
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
# Multi-stage build for the placeholder BFF (.NET 10).
|
||||||
|
# Build context is services/bff (see infra/docker-compose.yml).
|
||||||
|
FROM mcr.microsoft.com/dotnet/sdk:10.0 AS build
|
||||||
|
WORKDIR /src
|
||||||
|
|
||||||
|
# Restore first (cached unless the csproj changes).
|
||||||
|
COPY Bff.Api/Bff.Api.csproj Bff.Api/
|
||||||
|
RUN dotnet restore Bff.Api/Bff.Api.csproj
|
||||||
|
|
||||||
|
# Then build + publish.
|
||||||
|
COPY Bff.Api/ Bff.Api/
|
||||||
|
RUN dotnet publish Bff.Api/Bff.Api.csproj -c Release -o /app/publish /p:UseAppHost=false
|
||||||
|
|
||||||
|
FROM mcr.microsoft.com/dotnet/aspnet:10.0 AS runtime
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
# curl is used by the container HEALTHCHECK / compose healthcheck.
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends curl \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
COPY --from=build /app/publish .
|
||||||
|
|
||||||
|
ENV ASPNETCORE_URLS=http://+:8080
|
||||||
|
EXPOSE 8080
|
||||||
|
|
||||||
|
HEALTHCHECK --interval=5s --timeout=3s --start-period=10s --retries=5 \
|
||||||
|
CMD curl -fsS http://localhost:8080/health || exit 1
|
||||||
|
|
||||||
|
ENTRYPOINT ["dotnet", "Bff.Api.dll"]
|
||||||
Reference in New Issue
Block a user