Byakko

A file sharing platform for uploading, managing, and retrieving digital assets. Built with Clean Architecture on .NET 10, with Blazor WebAssembly frontends and a PostgreSQL + MinIO backend.

User Guide

Guide Description
File Upload Upload and manage digital assets
GDPR Request and manage account deletion (GDPR)

Developer Guide

Guide Description
Install Guide Set up and run the platform locally
Aspire Aspire orchestration and run modes (Project, DockerFile, ContainerImage)
Authentication Server Configure Keycloak for JWT authentication
Database Run and manage PostgreSQL migrations
DNS Configure DNS records for production deployment
Pipelines CI/CD pipelines for building, testing, Docker, and SonarCloud
DocFX Build and deploy the documentation site
Setup Server Prepare an Ubuntu 25.04 server for production deployment
Ubuntu Dev Environment Set up HTTPS certificates and Docker on Ubuntu 25.04
Kubernetes Deploy and manage the platform on Kubernetes with Helm
Rider Settings Recommended JetBrains Rider configuration

Architecture

Guide Description
System Context High-level view of users and the system
Containers Internal containers and their interactions
Project Dependencies Clean Architecture layer dependency diagram
Structurizr Editing and exporting C4 diagrams locally

Reference

Guide Description
Useful Links External links and resources
Versions Changelog and version history