Skip to content

README.md

Latest commit

 

History

History
232 lines (134 loc) · 4.21 KB

README.md

File metadata and controls

232 lines (134 loc) · 4.21 KB

📌 Task Management API

.NET Build & Deploy Azure Status

Production-ready ASP.NET Core Web API demonstrating secure authentication, clean architecture, automated testing, CI/CD, and Azure cloud deployment.

🌍 Live Demo

🔎 Swagger UI

👉 https://manage-task-fdenbvbxe3hbffc2.southafricanorth-01.azurewebsites.net/swagger

❤️ Health Check

👉 https://manage-task-fdenbvbxe3hbffc2.southafricanorth-01.azurewebsites.net/health

🚀 Overview

Task Management API is a secure RESTful API built using ASP.NET Core (.NET 8).

It demonstrates real-world backend engineering practices:

  • 🔐 JWT Authentication & Authorization
  • 🧱 Clean Layered Architecture
  • 🗄 Entity Framework Core (SQLite)
  • 🧪 Unit Testing (xUnit + Moq)
  • 🔄 CI/CD with GitHub Actions
  • ☁️ Azure App Service Deployment
  • 📊 Production Monitoring Ready

🏗 System Architecture

Layered Architecture

Client → Controller → Service → Repository → Database

flowchart LR

Client["Client (Swagger / Postman)"]

subgraph API["ASP.NET Core Web API (.NET 8)"]
Controllers["Controllers"]
Middleware["JWT Authentication"]
Swagger["Swagger / OpenAPI"]
end

subgraph Services["Business Layer"]
Service["TaskService"]
end

subgraph Data["Data Layer"]
Repository["TaskRepository"]
EFCore["EF Core"]
Database[("SQLite")]
end

CI["GitHub Actions"]
Azure["Azure App Service"]

Client --> Controllers
Controllers --> Service
Service --> Repository
Repository --> EFCore
EFCore --> Database

Controllers --> Middleware
Controllers --> Swagger

CI --> Azure
Azure --> Client
Loading

🔐 Authentication Flow

sequenceDiagram
    participant Client
    participant AuthController
    participant JWT
    participant API

    Client->>AuthController: POST /api/auth/login
    AuthController->>JWT: Generate Token
    JWT-->>Client: Return JWT

    Client->>API: Request with Bearer Token
    API->>JWT: Validate Token
    JWT-->>API: Valid
    API-->>Client: Protected Resource
Loading

📷 Screenshots

✅ CI/CD Pipeline Success

🔎 Swagger UI (Live Deployment)

🔐 Features

  • JWT-secured authentication

  • Protected endpoints with [Authorize]

  • Full CRUD task management

  • Swagger UI with Bearer token support

  • Health check endpoint

  • Environment-based configuration

  • Automated CI pipeline

  • Production-ready cloud deployment

🧪 Testing Strategy

Unit tests validate:

  • Business logic (Service layer)

  • Repository interactions (mocked)

  • Validation rules and expected outputs

  • Testing Tools

  • xUnit

  • Moq

Tests run automatically via GitHub Actions.

🔄 CI/CD Pipeline

On every push to main:

  • Restore dependencies

  • Build solution

  • Run unit tests

  • Publish build artifacts

  • Deploy to Azure App Service

  • Ensures quality, reliability, and production stability.

☁️ Deployment & DevOps

Hosted on Azure App Service (Linux).

Configured with:

  • GitHub Actions deployment workflow

  • Secure publish profile secret

  • Environment variables via Azure Configuration

  • HTTPS enforced at platform level

  • Production monitoring ready (Application Insights)

⚙️ Production Environment Variables

Configured in Azure:

Jwt__Key

Jwt__Issuer

Jwt__Audience

ConnectionStrings__DefaultConnection

ASPNETCORE_ENVIRONMENT=Production

🧪 Run Locally

    git clone https://github.com/LauraBailie/task-management-api.git
    cd task-management-api
    dotnet restore
    dotnet run

Open:

https://localhost:5253/swagger

📈 Future Enhancements

  • Azure SQL integration

  • Docker containerization

  • Role-based authorization

  • Front-end client (React or Blazor)

  • Integration testing

  • API versioning