StockManager

StockManager – backend (ASP.NET Core/.NET 8) for warehouse inventory management, built with Clean Architecture + CQRS (MediatR), logging (Serilog), and observability (OpenTelemetry).
Project runs locally via Docker Compose (API + MS SQL Server + Redis). In the cloud, it operates as Azure Container Apps with supporting resources (SQL Database, Storage – Azure Files, Container Registry, Key Vault, Application Insights, etc.).

Table of Contents

• Architecture & Layers
• Prerequisites
• Quickstart – Local (Docker Compose)
• Configuration - local connection string
• Tests
• NuGet Packages
• Azure Deployment
• Screenshots
• Known Limitations / Tips
• License

---

Architecture & Layers

The repository (REST API/) is divided into projects:

• StockManager.Core.Domain – domain models/entities.
• StockManager.Application – application logic, CQRS (commands/queries), MediatR, validation, etc.
• StockManager.Infrastructure – data access (EF Core for Azure SQL), integrations (RabbitMQ, Azure Blob Storage, Redis), interface implementations.
• StockManager – ASP.NET Core Web API app (endpoints, DI config, Background Workers for document generation, Serilog, OTEL).
• Files: docker-compose.yml, docker-compose.override.yml, .env_template, Directory.Packages.props (central NuGet versions), etc.

---

Prerequisites

• Docker Desktop 4.x+
• Docker Compose v2 (bundled with Docker Desktop)
• (Optional) .NET 8 SDK if you want to run the API outside Docker

---

Quickstart – Local (Docker Compose)

1. Clone the repo and go to the REST API/ directory.

2. Create a .env file from .env_template and fill in required variables.

3. Build and run the stack:

   docker compose up --build -d

   This command will:

   • Pull images for mssql/server:2022-latest, redis:7-alpine, and rabbitmq:3-management,
   • Build the stockmanager:latest image (your API),
   • Start 4 containers: stockmanager-sql (1433), redis (6379), rabbitmq (5672/15672), stockmanager (API – mapped to e.g., http://localhost:5000 / http://localhost:8080 as per compose).

   Check containers:

   docker ps
   # Or use Docker Desktop UI

   API:

   • Swagger/HTTP: http://localhost:5000 (or the port you set in compose – use "Show all ports" in Docker Desktop).
   • If using HTTPS – the relevant port is visible in Docker Desktop/compose.

   Note: First SQL Server startup may take up to a minute. If API starts before SQL is ready, compose includes depends_on, but sometimes it's best to give SQL a moment before API migrations.

---

Configuration – local connection string

  Server=stockmanager-sql,1433;Database=StockManagerDb;
  User Id=sa;Password=<YourSAPassword>;
  TrustServerCertificate=True;Encrypt=False;

---

Asynchronous Logistics Flow

The project implements a modern, asynchronous architecture for warehouse operations:

1. Operation Creation: When a user creates a warehouse operation (PZ, WZ, RW, MM), the API updates the inventory and publishes a "Light Message" to RabbitMQ.
2. Background Processing: A DocumentGenerationWorker (HostedService) listens for these messages.
3. PDF Generation: The worker fetches operation details, generates a professional PDF receipt using QuestPDF.
4. Cloud Storage: The PDF is uploaded to Azure Blob Storage.
5. Audit & Retrieval: Metadata is saved to the database, allowing users to download generated documents via the React UI.

---

Tests

The repository contains xUnit tests. In Visual Studio or CLI:

dotnet test

The Dockerfile (test stage) also builds and runs tests – you can see statuses in build logs.

---

NuGet Packages

Main dependencies used in the project (based on structure/config):

Runtime / Infrastructure

• Microsoft.EntityFrameworkCore
• Microsoft.EntityFrameworkCore.SqlServer
• Microsoft.EntityFrameworkCore.Tools
• StackExchange.Redis or Microsoft.Extensions.Caching.StackExchangeRedis
• MediatR / MediatR.Extensions.Microsoft.DependencyInjection
• Serilog / Serilog.Extensions.Hosting / Serilog.Sinks.Console
• OpenTelemetry.Extensions.Hosting
• OpenTelemetry.Instrumentation.AspNetCore
• OpenTelemetry.Instrumentation.Http
• OpenTelemetry.Instrumentation.Runtime
• OpenTelemetry.Exporter.OpenTelemetryProtocol
• Azure.Identity, Azure.Monitor.OpenTelemetry.Exporter
• Azure.Storage.Blobs (Cloud file storage)
• RabbitMQ.Client (Messaging)
• QuestPDF (PDF generation engine)
• Microsoft.AspNetCore.Authentication.JwtBearer

Validation / Mapping

• FluentValidation / FluentValidation.DependencyInjectionExtensions
• AutoMapper / AutoMapper.Extensions.Microsoft.DependencyInjection

Testing

• xunit
• xunit.runner.visualstudio
• FluentAssertions
• Moq

---

Azure Deployment & CI/CD

The backend runs on Azure Container Apps (ACA), while the application image is built and pushed to GitHub Container Registry (GHCR) automatically via GitHub Actions pipelines.

The automated process utilizes Microsoft Entra ID (OIDC) Federated Credentials, completely eliminating the need for storing explicit passwords/secrets in Azure connection strings.

Environment consists of:

• GitHub Actions – Continuous Integration / Continuous Deployment pipeline
• GitHub Container Registry (GHCR) – Docker image registry
• Azure Container Apps – API container host
• Azure SQL Server + Azure SQL Database – database
• Azure Storage – Azure Blob Storage – document storage
• Azure Service Bus or RabbitMQ – messaging backbone
• Azure Key Vault – secrets handling
• Application Insights (+ Log Analytics Workspace) – telemetry & logs
• Managed Environment – ACA environment

---

Screenshots

• Local (Docker Desktop):
  

• ACA:

• Resource Group – all services:
  

• CI/CD via GitHub Actions & Entra ID (OIDC):
  

• xUnit tests – passing:
  

• Also repository has a lockage to push commits to main branch.

---

Known Limitations / Tips

• Azure SQL (free/serverless) can quickly exhaust free quota if the app keeps connections alive.
• For demo: resume the database briefly (Compute + Storage → Continue using database with additional charges), and stop after demo (or set autopause).
• In the app, separate readiness/liveness checks from DB tests and add exponential backoff for SQL errors.
• Store secrets in Key Vault (+ Managed Identity in ACA).
• For monitoring, send OTEL data to Application Insights.

---

License

MIT