Getting started

OxyKit is three MIT-licensed products — Render, Mail, and Flow — plus the mail-web companion for Mail’s dashboard.

Product	Port	Role
OxyKit.Render	:5066	Document render engine
OxyKit.Mail	:5026	Email delivery API
oxykit-mail-web	:5173	Mail dashboard SPA
OxyKit.Flow	:5077	Job orchestrator

Requires the .NET 10 SDK (or the .NET 10 runtime if you only run release zips).

Clients (NuGet)

dotnet add package OxyKit.Render.Client
dotnet add package OxyKit.Mail.Client

→ Integrate › .NET Clients — packages and host releases

Run from source

1. Start Render, then Mail (+ mail-web) and/or Flow as needed.
2. Smoke each API with its hoppscotch/ collection (see product chapters).

dotnet run --project OxyKit.Render/src/OxyKit.Render.Api
dotnet run --project OxyKit.Mail/src/OxyKit.Mail/OxyKit.Mail.csproj
dotnet run --project OxyKit.Flow/src/OxyKit.Flow/OxyKit.Flow.csproj

Dev API keys (Development):

Service	Header
Render	X-OxyKit-Render-Key: dev-local-key
Flow	X-OxyKit-Flow-Key: dev-flow-key
Mail	X-Api-Key (create a sender key after bootstrap)

Run from GitHub Releases

Each core ships framework-dependent app zips (linux-x64 / win-x64 / osx-arm64) on its Releases page — no NuGet package for the hosts themselves.

Product	Download
Render	app zips
Mail	app zips
Flow	app zips

Unzip, set API keys (and SMTP for Mail), point Flow at a running Render engine, then run the host binary. See each zip’s README.txt and the product docs.

Next

• Architecture — how the three cores relate
• Local compose — run the golden path together
• Integrate — Clients and Framework HOW-TO