# Stl.Fusion.Samples

**Repository Path**: bephbin/Stl.Fusion.Samples

## Basic Information

- **Project Name**: Stl.Fusion.Samples
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-07-30
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![](docs/img/Banner.jpg)

Welcome to a collection of samples for [Stl.Fusion](https://github.com/servicetitan/Stl.Fusion)!

> All project updates are published on our [Discord Server](https://discord.gg/EKEwv6d); it's also the best place for Q/A.\
> [![Build](https://github.com/servicetitan/Stl.Fusion.Samples/workflows/Build/badge.svg)](https://github.com/servicetitan/Stl.Extras/actions?query=workflow%3A%22Build%22)

## Running Samples

The simplest way:
- Install [Docker](https://docs.docker.com/get-docker/) and
  [Docker Compose](https://docs.docker.com/compose/install/)
- To run [Hello World](src/HelloWorld):
  `docker-compose run sample_hello_world dotnet Samples.HelloWorld.dll`
- To run [Blazor Samples](src/Blazor):
  1. Run `docker-compose up --build sample_blazor` in the root folder of this repository
  2. Open http://localhost:5005/.
- To run [Tutorial](docs/tutorial/README.md):
  1. Run `docker-compose up --build tutorial` in the root folder of this repository
  2. Open https://localhost:50005/README.md.

And if you'd rather run everything locally:
- Install the latest [.NET Core SDK 3.1](https://dotnet.microsoft.com/download)
- To run [Hello World](src/HelloWorld):
  `dotnet run -p src/HelloWorld/HelloWorld.csproj`
- To run [Blazor Samples](src/Blazor):
  1. Run `dotnet run --project src/Blazor/Server/Samples.Blazor.Server.csproj`
  2. Open http://localhost:5005/.
- To run [Tutorial](docs/tutorial/README.md):
  1. Install [Try .NET](https://github.com/dotnet/try/blob/master/DotNetTryLocal.md).
     Its release version may fail to run the code, so we recommend to install 
     the preview version of this tool.
  2. Run `dotnet try --port 50005 docs/tutorial` in the root folder of this repository
  3. Open https://localhost:50005/README.md.

## What's Inside?

### 1. Tutorial

It's interactive – you can simply [browse it](docs/tutorial/README.md), but to
modify and run the C# code presented there, you need
[Try .NET](https://github.com/dotnet/try/blob/master/DotNetTryLocal.md)
or [Docker](https://www.docker.com/).

### 2. Blazor Samples

It's a dual-mode [Blazor](https://docs.microsoft.com/en-us/aspnet/core/blazor/hosting-models?view=aspnetcore-3.1) SPA hosted by
[ASP.NET Core](https://dotnet.microsoft.com/apps/aspnet) website,
which also serves its API. The application includes:
* "Server Time" and "Server Screen" pages showing the simplest timeout-based invalidation
* "Chat" - a tiny chat relying on event-based invalidation
* "Composition" shows Fusion's ability to use both  local `IComputed<T>` instances 
  and client-side replicas of similar server-side instances to compute a new value
  that properly tracks both local and remote dependencies.

![](docs/img/Samples-Blazor.gif)

The app supports **both (!)** Server-Side Blazor and Blazor WebAssembly modes &ndash;
you can switch the mode on "Home" page.

![](docs/img/Samples-Blazor-DualMode.gif)

Moreover, it also exposes a regular RESTful API &ndash;
try invoking any of endpoints there right from embedded Swagger console.

![](docs/img/SwaggerDoc.jpg)

### 3. Hello World Sample

`HelloWorld` is a basic sample showing how to create a `[ComputedServiceMethod]`
that depends on output of another method (i.e. how to create a dependency chain),
invoke such methods from code, and react to changes in concurrent thread.

Check out [its source code](src/HelloWorld/Program.cs).

![](docs/img/Samples-HelloWorld.gif)

## Useful Links

* Check out [Stl.Fusion repository](https://github.com/servicetitan/Stl.Fusion) 
* Read the [Documentation](https://github.com/servicetitan/Stl.Fusion/blob/master/docs/README.md)
* Join our [Discord Server](https://discord.gg/EKEwv6d) to ask questions and track project updates.