Skip to content

README.md

Latest commit

 

History

History
84 lines (69 loc) · 4.64 KB

README.md

File metadata and controls

84 lines (69 loc) · 4.64 KB
Raw

Elsa Studio documentation

The opt-in React Studio Preview lives under studio/react/. Start with Try the React Studio Preview and its 3.11 release preparation notes. Its source import receipt preserves the original tree and history; the delivery plan tracks the remaining Preview requirements.

Studio's backend-facing clients, Blazor modules and hosts live under studio/src, with browser fixtures under studio/test, existing .NET tests beside their modules/framework under studio/src/, and samples under studio/samples. Open the repository's canonical Elsa.sln to change backend and Studio together, or use the root Elsa.Studio.slnf for a focused selection including required dependencies. Read Studio contributor guidance and the root contribution guide.

The standalone Studio README retained in the import provenance uses former clone and solution paths; follow this page for current development.

Studio's Designer and DomInterop browser bundles use Node 22. From the repository root, run the reviewed ClientLib build script and build the Studio selection:

./scripts/integration-program/build_studio_clientlibs.sh
dotnet build Elsa.Studio.slnf
dotnet test studio/src/modules/Elsa.Studio.Workflows.Designer.Tests/Elsa.Studio.Workflows.Designer.Tests.csproj

Start a backend such as Elsa.Server.Web and run the Elsa.Studio.Host.Server project in separate terminals to work on the Blazor UI. Its default backend URL is https://localhost:7294/elsa/api. The checked-in Elsa.Server.Web launch profile instead listens on https://localhost:5001; for this pairing, put the following in the Studio host's ignored appsettings.Local.json:

{
  "Backend": {
    "Url": "https://localhost:5001/elsa/api"
  }
}

The host defaults to ElsaIdentity authentication. Keep developer credentials and client secrets out of committed settings. The paired backend/Blazor proof records the bounded source-breakpoint demonstration; it is not a production host configuration.

The interface design system is the Studio-approved baseline dated 2026-09-01. It describes UI conventions for Studio contributors; evaluate new work against the current module and its tests as well.

The 3.6.0-rc1 release notes are retained release history. They describe that release candidate, not the current release or a consolidated Core release.

The develop 3.6 performance report is also retained as historical evidence. Its measurements, code locations and claims of implemented fixes describe the source at the time; they have not been revalidated for the consolidated Studio modules. See the asset disposition before citing it as current behavior.

All three documents are byte-for-byte copies of the corresponding files at Studio commit f0eeb3c7428443b09512049fe890635fa4f7b427. The first two import dispositions and verification are recorded in the integration-program asset note.

The React Studio preview is being prepared for 3.11 under #8859. Its delivery plan tracks the import and package, hosting, feature-parity and release gates. The independent modularity spike exercises loading React UI modules from packed NuGet packages; it is an architecture proof, not the integrated preview. The Blazor Studio remains the default.

Planned native compensation

The Native compensation authoring, inspection and recovery program is the current program entrypoint for scope, ownership and readiness. The Studio interaction plan records Studio design details within the reviewed Elsa 3 adaptation packet. Standing owner authorization permits delivery through the remaining technical gates; these plans do not claim implementation or proof.