https://github.com/csharpfritz/fritz.streamtools
Handy tools for managing my live stream, built with ASP.NET Core
https://github.com/csharpfritz/fritz.streamtools
Last synced: about 1 month ago
JSON representation
Handy tools for managing my live stream, built with ASP.NET Core
- Host: GitHub
- URL: https://github.com/csharpfritz/fritz.streamtools
- Owner: csharpfritz
- License: mit
- Created: 2017-12-12T17:04:49.000Z (over 7 years ago)
- Default Branch: dev
- Last Pushed: 2025-02-20T10:42:21.000Z (3 months ago)
- Last Synced: 2025-04-04T00:07:33.441Z (about 2 months ago)
- Language: C#
- Homepage:
- Size: 2.3 MB
- Stars: 151
- Watchers: 8
- Forks: 73
- Open Issues: 70
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fritz.StreamTools
Handy tools for managing my a live video stream and outputting video widgets that can be used directly in OBS or other streaming tools.
[](https://dev.azure.com/FritzAndFriends/Fritz.StreamTools/_build/latest?definitionId=7)
## Features
The project is intended to be built as a Docker container and configured with a series of environment variables. It is intended to support a single-user, and not run on the public-facing internet.
The following features are supported by this project:
* A checklist rundown of segments of the show (/rundown) that is updated from another page (/admin)
* A followers count API that reports the total number of followers: GET /api/Followers
* A followers count page that can be easily styled and formatted at /Followers/Count
* A followers goal meter that can be sized and have its goal caption and value set, complete with configuration screen at /Followers/Goal/Configuration
## Services Supported
The project supports reading stream metrics from the following services:
* Mixer
* Twitch
## Contributing
This application was built with ASP.NET Core 2.0 and can be built on Mac, Linux, and Windows. Download the [.NET SDK](https://dot.net) and grab a copy of [Visual Studio Code](https://code.visualstudio.com) to get started on any platform.
### How to contribute
1. Open new issue or find some interesting,
2. Fork repository,
3. Create new branch in your fork from dev,
4. Code something awesome,
5. Create pull-request from your branch to our dev branch,
6. In pull request write what you did and why, if it requires an explanation,
7. (Optional) Answer questions or correct your code if needed,
8. Celebrate that you are new Contributor :)
[More about forking](https://guides.github.com/activities/forking/)
### Building and running locally
1. Ensure pre-requisites:
1. [.NET Core 2.1 SDK](https://www.microsoft.com/net/download)
1. [Docker](https://docs.docker.com/install)
1. Fork repository
1. Clone
1. (Recommended) Open in editor such as Visual Studio or Visual Studio Code
1. Add GitHub > **User** and **[AuthenticationToken](https://github.com/settings/tokens)** to Fritz.StreamTools\appsettings.json (no scopes needed)
1. Run `dotnet build .\Fritz.StreamTools.sln` to confirm build success
1. If error: *A compatible SDK version for global.json version*, update the version in global.json to match your .NET version.
1. If error: *\Fritz.StreamTools\Test\Test.csproj : error NU1605: Detected package downgrade*, update the version numbers to match what is expected based on the error.
1. Run `docker-compose -f "docker-compose.yml" -f "docker-compose.override.yml" up -d --build`
1. Run `docker ps` to find the port (for example: "32768" in "0.0.0.0:32768->80/tcp")
1. Browse to http://localhost[port]
## Configuration
### Google Fonts Api
To use your own Google Fonts Api key without modifying the `Fritz.StreamTools\appSettings.json` you can place your key in the `secrets.json` file in the [path appropriate for your OS](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-2.1&tabs=visual-studio#how-the-secret-manager-tool-works).
The *userSecretsId* is **78c713a0-80e0-4e16-956a-33cf16f08a02** and can be found in `Fritz.StreamTools\Fritz.StreamTools.csproj`.
If you are using Visual Studio you can use the [integrated User Secrets management UI](https://blogs.msdn.microsoft.com/mihansen/2017/09/10/managing-secrets-in-net-core-2-0-apps/)
The `secrets.json` file should look like this
{
"GoogleFontsApi": {
"Key": ""
}
}
### Naming guideline for unit tests
* Create a folder for each "logical class"
* Create a test class for each feature to test - end with "Should"
* Test Methods should describe what they are inspecting and what they're given, if anything.. ending with "\_Given..."
Example: StreamService.CurrentFollowerCountShould.MatchCurrentFollowerCount_GivenOneService