Mango Messenger Web API

Description

Mango Messenger is an opensource instant messaging system implemented using .NET Core and Angular frameworks. In general, mango messenger is considered to be a bachelor's degree project. Bachelor's degree has been successfully completed by the team of three students on 10-02-2022. However, it is worth to continue progress on the project pursuing another predefined goals.

How it works (v1): https://www.youtube.com/watch?v=3lh3we1DrEY

Main goals of the project

Implementation of simple, maintainable, safe and scalable code base following the KISS and YAGNI software development principles
To maintain the code quality using static code analyzers such as ReSharper, SonarCloud where SonarCloud analysis is a part of the CI/CD pipeline with further publication of the quality gate results
To setup proper IDE configurations and code style rules using editor config and StyleCop extensions
To maintain high (> 70%) code coverage using unit tests, integration tests with ongoing publication of the coverage report to the Azure DevOps workflow statistics
To implement layered architecture where each layers is a separate project responsible for single part of the application. For example, the Domain layer is responsible for the business logic and validates itself
To implement productive, quick and safe development cycle. It is mainly about organization of the CI/CD process using Azure DevOps and Azure pipelines so that each pull request to be validated and tested. Moreover, the CD (Continuous Deployment) must be confirmed manually be designated person
To implement and deploy IaaC using Terraform
To implement cryptographic protocol that allows End-to-end (E2E) encryption using confidential clients
To implement semantic versioning as part of CI/CD pipeline
To implement and deploy ARM templates utilizing Azure Pipelines and Github Actions
To explain release and versioning strategy
To implement CD pipeline to deploy app to IIS as part of Windows VM
To implement CD pipeline to deploy app to Nginx as part of Linux VM
To implement pen testing using OWASP ZAP tool
To implement various deployment patterns like Blue-Green, Canary etc
To implement release flow according to the documentation: PDF

Infrastructure diagram and details

Windows app service plan F1-tier
Windows app service
Azure StorageV2 account with LRS redundancy
Azure storage account
Azure SQL server
Azure SQL database S0 instance with 10 database transaction units [Serverless]
Azure KeyVault
Application Insights

Screenshots

Chats

Contacts

Settings

Build and run the project

Required Software

.NET SDK 6.0.202 or later: https://dotnet.microsoft.com/en-us/download
NVM for windows: https://github.com/coreybutler/nvm-windows
Azure storage explorer: https://azure.microsoft.com/en-us/products/storage/storage-explorer
Azure data studio: https://azure.microsoft.com/en-us/products/data-studio
Docker: https://docs.docker.com/desktop/windows/install
Angular: 13.3.5
Angular CLI: 13.3.4
NodeJS: 16.13.1
NPM: 8.1.2
Code Editor & IDE: Visual studio, Visual studio code, Rider
VS Code Plugins:
- ESlint
- Prettier

Run docker compose

docker-compose build
docker-compose up

Run in debug mode

Install NVM: https://github.com/coreybutler/nvm-windows
Install NodeJS 14.17.3 using NVM & PowerShell as Administrator: nvm install 16.13.1
Use NodeJS 14.17.3 using NVM via PowerShell as Administrator: nvm use 16.13.1
Check NodeJS installed properly (should be 16.13.1): node -v
Check NPM installed properly (should be 8.1.2): npm -v
Go to the project folder: cd MangoAPI.Client
Restore node modules: npm ci
Install Angular CLI globally: npm install -g @angular/cli@13.3.4
Open PowerShell as Administrator and type: Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
Check that Angular CLI installed properly: ng version
Build project for development using Angular CLI: ng build --aot --configuration development
NOTE: for production command is: ng build --aot --configuration production
Restore .NET packages: cd .. & dotnet restore
Run the .NET web API: dotnet run
Navigate to the swagger: https://localhost:5001/swagger/index.html
Navigate to the root url: https://localhost:5001/app

In case of localhost HTTPS certificate issues: https://stackoverflow.com/a/67182991

Run integration tests

Run MsSQL database container: docker run -e SA_PASSWORD=x2yiJt!Fs -e ACCEPT_EULA=y --name mango-mssql-db --hostname mango-mssql-db -p 1433:1433 -d mcr.microsoft.com/mssql/server:2019-latest
Install Azurite: https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=npm
- npm install -g azurite
- azurite --silent --location c:\azurite --debug c:\azurite\debug.log
- Upload mock images from ./img/seed_images/* to local Azure Blob container

Technology stack

SDK: .NET 6
Frameworks: ASP .NET, Angular
Persistence:
- Database: MS SQL Server
- ORM: Entity Framework Core
- Storage: Azure Blob Storage
Authorization: ASP .NET Identity, JWT Bearer
Business Logic:
- MediatR
- Fluent Validation
- AutoMapper
Presentation:
- API Documentation: OpenAPI (Swagger)
- Realtime Communication: SignalR
- Frontend Development: Angular
Unit and Integration Testing: XUnit, FluentAssertions
Code Quality Tools: SonarQube
Containerization: Docker
Continuous Integration: Azure Pipelines, GitHub Actions
Continuous Deployment: Azure Pipelines, GitHub Actions, Azure DevOps, Azure App Service
Programming languages: C#, SQL, TypeScript
Tools & IDE: Visual Studio, Rider, VS Code, WebStorm, SMSS, Postman

Tasks management

Each task has an assigned number in the format MANGO-ID
Active tasks are available on the Trello board: https://trello.com/b/Z7IlfrRb/mango-messenger-trello
Each task branch is based on the actual develop branch and pull requested there on complete

GitHub flow

Fork this repository
Clone this repository using git clone https://github.com/${{ username }}/MangoMessengerAPI.git
If repository is cloned already then pull last changes from develop using
- git checkout develop
- git pull
Create new branch based on develop with name according to MANGO-ID of the task
Solve the task
Create pull request to develop

Commit messages

In case of bug fix, example of commit message bugfix: some bug fixed
In case of feature, example of commit message feature: some new functionality added
In case of refactor, example of commit message refactor: some code part refactored