The Base Project

Welcome to my Playground!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact
7. Acknowledgments

About The Project

An overview of my playground, the landscape will most definitely change so please check back in from time to time...

(back to top)

Built With

• .NET 8
• Blazor
• SignalR
• OpenTelemetry

(back to top)

Getting Started

Here's how you may go about with setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Things you need to use the software and how to install them.

• Docker

Installation

1. Clone the repo

   git clone https://github.com/gitViwe/open-hubviwe.git

2. Navigate to the root folder the-base

3. Run via Docker

   docker compose up -d
   

Troubleshoot

Docker compose

• If you run into this error while building images: net/http: TLS handshake timeout, try to pull the mssql/server image seperately by running the command: docker pull mcr.microsoft.com/mssql/server:2019-CU18-ubuntu-20.04

(back to top)

Usage

Let's pop open the toy box and discover the playground.

Go to the Blazor playground to get started.

For more examples, please refer to the documentation

• System Architecture
• Authentication API
• Feature API
• Realtime API

(back to top)

Roadmap

• API Gateway:
  • Add YARP
  • Health Checks
  • OpenTelemetry
  • Docker support
  • Azure App Configuration
  • Rate limiting
  • Versioning
  • Cache support
  • Compression support
• Authentication API:
  • Open API
  • Health Check
  • OpenTelemetry
  • Docker support
  • JSON Web Token
  • QR code authenticator
  • Azure App Configuration
  • Permissions management
  • SendGrid
  • FIDO2
  • Background service
  • gRPC (internal communication)
  • Feature Management
• Feature API:
  • Open API
  • Health Check
  • OpenTelemetry
  • Docker support
  • Azure App Configuration
  • Database Schema (Game)
  • Realtime integration (Game)
  • Database Schema (Blog)
  • Background service
  • gRPC (internal communication)
  • Feature Management
• Realtime API:
  • GraphQL
  • SignalR
  • Health Check
  • Azure App Configuration
  • OpenTelemetry
  • Feature Management
• Blazor Web Assembly:
  • MudBlazor UI
  • Mobile Client
  • Desktop Administrator Client
  • OpenTelemetry
  • Docker support
  • Local Storage
  • Cache Storage
  • Authorization & Authentication
  • SignalR Page UI
  • GraphQL Page UI
  • UI Components (SignalR demo)
  • UI Components (Blog)
  • FIDO2
  • User Account Management
  • Role Management
  • Role Permission Management
  • User Role Management
  • User Permission Management
  • SignalR Integration
  • File Upload
  • Feature Management
• Observability:
  • OpenTelemetry collector
  • Seq logging (Docker)
  • Jaeger traces (Docker)
  • Grafana metrics (Docker)
  • Honeycomb (Production)
• Pipeline:
  • GitHub action (general)
  • GitHub action (Gateway)
  • GitHub action (Authentication)
  • GitHub action (Feature)
  • GitHub action (Realtime)
• Azure:
  • API Gateway
  • Authentication API
  • Feature API
  • Notification API
  • SignalR Server
  • Blazor Web Assembly

(back to top)