-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #494 from TimeWarpEngineering/Cramer/2024-10-20/Sa…
…mples Cramer/2024 10 20/samples
- Loading branch information
Showing
12 changed files
with
187 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| uid: TimeWarpState:Badges.md | ||
| title: Badges | ||
| --- | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state/actions) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state/issues) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state/issues) | ||
|
|
||
| [](https://www.nuget.org/packages/TimeWarp.State/) | ||
| [](https://www.nuget.org/packages/TimeWarp.State/) | ||
| [](https://www.nuget.org/packages/TimeWarp.State/) | ||
|
|
||
| [](https://twitter.com/intent/tweet?url=https://github.com/TimeWarpEngineering/timewarp-state) | ||
| [](https://dotnet.microsoft.com) | ||
|
|
||
| [](https://discord.gg/7F4bS2T) | ||
| [](https://twitter.com/intent/follow?screen_name=StevenTCramer) | ||
| [](https://twitter.com/intent/follow?screen_name=TheFreezeTeam1) | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| uid: TimeWarp.State.Contact.md | ||
| title: Contact | ||
| --- | ||
|
|
||
| ## Contact | ||
|
|
||
| If you have an issue and don't receive a timely response, feel free to reach out on our [Discord server](https://discord.gg/A55JARGKKP). | ||
|
|
||
| [](https://discord.gg/7F4bS2T) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| uid: TimeWarp.State.GettingStarted.md | ||
| title: Getting Started | ||
| --- | ||
|
|
||
| ## Getting Started | ||
|
|
||
| If you are just beginning with Blazor then I recommend you start at the [dotnet blazor site](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor). | ||
|
|
||
| If you already know a bit about Blazor then I recommend the [tutorial](xref:TimeWarp.State:00-StateActionHandler.md) | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| uid: TimeWarp.State.GiveAStar.md | ||
| title: Give a Star | ||
| --- | ||
|
|
||
| ## Give a Star! :star: | ||
|
|
||
| If you find this project useful, please give it a star. Thanks! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| uid: TimeWarp.State.Installation.md | ||
| title: Installation | ||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| ```console | ||
| dotnet add package TimeWarp.State | ||
| dotnet add package TimeWarp.State.Plus | ||
| ``` | ||
|
|
||
| Check out the latest NuGet packages on the [TimeWarp Enterprises NuGet page](https://www.nuget.org/profiles/TimeWarp.Enterprises). | ||
|
|
||
| * [TimeWarp.State](https://www.nuget.org/packages/TimeWarp.State/) [](https://www.nuget.org/packages/TimeWarp.State/) | ||
| * [TimeWarp.State.Plus](https://www.nuget.org/packages/TimeWarp.State.Plus/) [](https://www.nuget.org/packages/TimeWarp.State.Plus/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| uid: TimeWarp.State.License.md | ||
| title: License | ||
| --- | ||
|
|
||
| ## Unlicense | ||
|
|
||
| [](https://unlicense.org) | ||
| This project is licensed under the [Unlicense](https://unlicense.org). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| uid: TimeWarp.State.Releases.md | ||
| title: Releases | ||
| --- | ||
|
|
||
| ## Releases | ||
|
|
||
| View the [Release Notes](https://timewarpengineering.github.io/timewarp-state/ReleaseNotes/Release11.0.0.html) for detailed information on each release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| uid: TimeWarp.State.Summary.md | ||
| title: Summary | ||
| --- | ||
|
|
||
| # TimeWarp.State | ||
|
|
||
| **TimeWarp.State** (previously known as Blazor-State) is a fully asynchronous state management library for Blazor applications, leveraging the MediatR pipeline to implement the Flux pattern. It handles both Reducers and Effects consistently using async Handlers, simplifying the management of asynchronous operations throughout your app. | ||
|
|
||
| By utilizing the MediatR pipeline, TimeWarp.State enables a flexible, middleware-driven architecture for managing state, similar to the request-processing pipeline in ASP.NET. This approach allows developers to inject custom behaviors, such as logging, validation, and caching, directly into the state management flow. | ||
|
|
||
| In addition to the core library, we offer **[TimeWarp.State.Plus](/Source/TimeWarp.State.Plus)**, which extends the functionality with enhanced middleware, components, and tools to further streamline state management in complex Blazor applications. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1,72 @@ | ||
| [](https://dotnet.microsoft.com) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state) | ||
| [](https://discord.gg/7F4bS2T) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state/actions) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state/issues) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state/issues) | ||
|
|
||
| [](https://www.nuget.org/packages/TimeWarp.State/) | ||
| [](https://www.nuget.org/packages/TimeWarp.State/) | ||
| [](https://www.nuget.org/packages/TimeWarp.State/) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state/issues) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state) | ||
| [](https://github.com/TimeWarpEngineering/timewarp-state/issues) | ||
|
|
||
| [](https://twitter.com/intent/tweet?url=https://github.com/TimeWarpEngineering/timewarp-state) | ||
| [](https://dotnet.microsoft.com) | ||
|
|
||
| [](https://discord.gg/7F4bS2T) | ||
| [](https://twitter.com/intent/follow?screen_name=StevenTCramer) | ||
| [](https://twitter.com/intent/follow?screen_name=TheFreezeTeam1) | ||
|
|
||
| # TimeWarp.State | ||
|
|
||
|  | ||
|
|
||
| # TimeWarp.State | ||
|
|
||
| TimeWarp.State is a State Management architecture utilizing the MediatR pipeline to implement the flux pattern. | ||
| **TimeWarp.State** (previously known as Blazor-State) is a fully asynchronous state management library for Blazor applications, leveraging the MediatR pipeline to implement the Flux pattern. It handles both Reducers and Effects consistently using async Handlers, simplifying the management of asynchronous operations throughout your app. | ||
|
|
||
| We also offer [TimeWarp.State.Plus](/Source/TimeWarp.State.Plus), which extends the core functionality with additional features, middleware, and components to simplify and enhance your Blazor applications. | ||
| By utilizing the MediatR pipeline, TimeWarp.State enables a flexible, middleware-driven architecture for managing state, similar to the request-processing pipeline in ASP.NET. This approach allows developers to inject custom behaviors, such as logging, validation, and caching, directly into the state management flow. | ||
|
|
||
| In addition to the core library, we offer **[TimeWarp.State.Plus](/Source/TimeWarp.State.Plus)**, which extends the functionality with enhanced middleware, components, and tools to further streamline state management in complex Blazor applications. | ||
|
|
||
| ## Give a Star! :star: | ||
|
|
||
| If you find this project useful, please give it a star. Thanks! | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ## Getting started | ||
| If you are just beginning with Blazor then I recommend you start at the [dotnet blazor site](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor). | ||
|
|
||
| To quickly get started I recommend the [tutorial](https://timewarpengineering.github.io/timewarp-state/Samples/00-StateActionHandler/Readme.html) section of the full [Documentation](https://timewarpengineering.github.io/timewarp-state/). | ||
|
|
||
|  | ||
| If you already know a bit about Blazor then I recommend the [tutorial](xref:TimeWarp.State:00-StateActionHandler.md) | ||
|
|
||
|  | ||
|
|
||
| ## Installation | ||
|
|
||
| ```console | ||
| dotnet add package TimeWarp.State | ||
| dotnet add package TimeWarp.State.Plus | ||
| ``` | ||
|
|
||
| Check out the latest NuGet packages on the [TimeWarp NuGet page](https://www.nuget.org/profiles/TimeWarp.Enterprises). | ||
| Check out the latest NuGet packages on the [TimeWarp Enterprises NuGet page](https://www.nuget.org/profiles/TimeWarp.Enterprises). | ||
|
|
||
| * [TimeWarp.State](https://www.nuget.org/packages/TimeWarp.State/) [](https://www.nuget.org/packages/TimeWarp.State/) | ||
| * [TimeWarp.State.Plus](https://www.nuget.org/packages/TimeWarp.State.Plus/) [](https://www.nuget.org/packages/TimeWarp.State.Plus/) | ||
|
|
||
|
|
||
| ## Releases | ||
|
|
||
| View the [Release Notes](https://timewarpengineering.github.io/timewarp-state/ReleaseNotes/Release11.0.0.html) for detailed information on each release. | ||
|
|
||
|
|
||
| ## Unlicense | ||
|
|
||
| [](https://unlicense.org) | ||
| This project is licensed under the [Unlicense](https://unlicense.org). | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| Your contributions are welcome! Before starting any work, please open a [discussion](https://github.com/TimeWarpEngineering/timewarp-state/discussions). | ||
|
|
||
| Help with the [documentation](https://timewarpengineering.github.io/timewarp-state/) is also greatly appreciated. | ||
|
|
||
|
|
||
| ## Contact | ||
|
|
||
| If you have an issue and don't receive a timely response, feel free to reach out on our [Discord server](https://discord.gg/A55JARGKKP). | ||
|
|
||
| [](https://discord.gg/7F4bS2T) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # BuildReadMe.ps1 - Concatenate multiple Markdown files into a single README.md, removing YAML front matter. | ||
|
|
||
| # Function to remove YAML front matter from content | ||
| function Remove-YamlFrontMatter { | ||
| param([string]$content) | ||
| if ($content -match "^---\s*\r?\n([\s\S]*?)\r?\n---\s*\r?\n") { | ||
| return $content -replace "^---\s*\r?\n[\s\S]*?\r?\n---\s*\r?\n", "" | ||
| } | ||
| return $content | ||
| } | ||
|
|
||
| # Save the current directory and ensure we return to it after execution. | ||
| try { | ||
| Push-Location | ||
|
|
||
| # Define the list of files to include in the README.md in the desired order. | ||
| $files = @( | ||
| "../Documentation/Partials/Badges.md", | ||
| "../Documentation/Partials/Summary.md", | ||
| "../Documentation/Partials/GiveAStar.md", | ||
| "../Documentation/Partials/GettingStarted.md", | ||
| "../Documentation/Partials/Installation.md", | ||
| "../Documentation/Partials/Releases.md", | ||
| "../Documentation/Partials/License.md", | ||
| "../Documentation/Partials/Contributing.md", | ||
| "../Documentation/Partials/Contact.md" | ||
| ) | ||
|
|
||
| # Define the output file. | ||
| $outputFile = "../README.md" | ||
|
|
||
| # Remove the existing README.md if it exists to start fresh. | ||
| if (Test-Path $outputFile) { | ||
| Remove-Item $outputFile | ||
| } | ||
|
|
||
| # Concatenate each file's content into the README.md, removing YAML front matter. | ||
| foreach ($file in $files) { | ||
| if (Test-Path $file) { | ||
| $content = Get-Content $file -Raw | ||
| $contentWithoutFrontMatter = Remove-YamlFrontMatter $content | ||
| $contentWithoutFrontMatter | Add-Content $outputFile | ||
| } | ||
| else { | ||
| Write-Host "Warning: $file does not exist and will be skipped." | ||
| } | ||
| } | ||
|
|
||
| Write-Host "README.md has been successfully generated with YAML front matter removed." | ||
| } | ||
| catch { | ||
| Write-Host "An error occurred: $_" | ||
| } | ||
| finally { | ||
| # Return to the original directory. | ||
| Pop-Location | ||
| } |