Add project files.

2025-08-20 11:07:36 +03:30
parent 3863c74931
commit 1a308a4069
899 changed files with 85379 additions and 0 deletions
@@ -0,0 +1,54 @@
+# Elsa Studio
+
+<a href="./artwork/screenshot-1.png" target="_blank">
+  <p align="center">
+    <img src="./artwork/screenshot-1.png" alt="Elsa Studio workflow designer">
+  </p>
+</a>
+
+[![Nuget](https://img.shields.io/nuget/v/elsa)](https://www.nuget.org/packages/Elsa.Studio.Shell/)
+[![Build status](https://github.com/elsa-workflows/elsa-studio/actions/workflows/packages.yml/badge.svg?branch=main)](https://github.com/elsa-workflows/elsa-studio/actions/workflows/packages.yml)
+[![Discord](https://img.shields.io/discord/814605913783795763?label=chat&logo=discord)](https://discord.gg/hhChk5H472)
+[![Stack Overflow questions](https://img.shields.io/badge/stackoverflow-elsa_workflows-orange.svg)]( http://stackoverflow.com/questions/tagged/elsa-workflows )
+[![Translation status](https://hosted.weblate.org/widget/elsa-studio/svg-badge.svg)](https://hosted.weblate.org/engage/elsa-studio/)
+
+Elsa Studio is a modular, extensible application framework built with MudBlazor and is used to manage Elsa workflows and related entities.
+
+## Prerequisites
+
+- **.NET SDK**: Ensure you have both [.NET 8](https://dotnet.microsoft.com/download/dotnet/8.0) and [.NET 9](https://dotnet.microsoft.com/download/dotnet/9.0) SDKs installed.
+- **Node.js and npm**: Install [Node.js](https://nodejs.org/) (which includes npm) for the frontend tooling.
+
+## Setup
+
+1. **Clone the repository**: `git clone https://github.com/elsa-workflows/elsa-studio.git`
+2. **Navigate to the project directory**: `cd elsa-studio`
+
+## Before you build
+
+There are some assets that require `NPM` to build the assets prior to the project building. These have been configured to use an MSBUILD pre-build step and should not require any extra
+steps but should you run into any issues or want to build these ahead of time, take the following steps
+
+1. **Navigate to ClientLib folder in Elsa.Studio.DomInterop**: `cd .\src\framework\Elsa.Studio.DomInterop\ClientLib`
+1. **Get `NPM` ready to run**: `npm install`
+1. **Build the assets**: `npm run build`
+1. **Navigate to ClientLib folder in Elsa.Studio.Workflows.Designer**: `cd .\src\modules\Elsa.Studio.Workflows.Designer\ClientLib`
+1. **Get `NPM` ready to run**: `npm install`
+1. **Build the assets**: `npm run build`
+
+## Build and Run
+
+1. **Restore .NET dependencies**: `dotnet restore Elsa.Studio.sln`
+1. **Build the project**: `dotnet build Elsa.Studio.sln`
+1. **For Blazor Server Host**: `dotnet run --project .\src\hosts\Elsa.Studio.Host.Server\Elsa.Studio.Host.Server.csproj `
+1. **For Blazor Server WASM**: `dotnet run --project .\src\hosts\Elsa.Studio.Host.Wasm\Elsa.Studio.Host.Wasm.csproj`
+
+Explore the [Elsa Studio GitHub repository](https://github.com/elsa-workflows/elsa-studio) for more detailed information.
+
+## Localization
+
+Elsa Studio is translated using [Weblate](https://hosted.weblate.org/engage/elsa-studio/)
+
+<a href="https://hosted.weblate.org/engage/elsa-studio/">
+<img src="https://hosted.weblate.org/widget/elsa-studio/multi-green.svg" alt="Translation status" />
+</a>