Add Mikrus VPS deployment guide and automation scripts

[fszymaniak]

Summary

This PR adds comprehensive documentation and automation scripts for deploying TheOfficeAPI to Mikrus VPS servers, including a detailed deployment guide, quick-deploy bash script, and verification utilities.

Key Changes

• Documentation/MikrusVPSDeployment.md: Complete deployment guide covering:

  • VPS plan recommendations (S/M/L/XL/XXL) with cost analysis
  • Step-by-step deployment instructions
  • Docker and Docker Compose setup
  • Nginx reverse proxy configuration
  • SSL/TLS setup with Let's Encrypt
  • Firewall configuration with UFW
  • Maintenance, troubleshooting, and security best practices
  • Performance optimization tips

• scripts/deploy-mikrus.sh: Automated deployment script that:

  • Installs Docker and Docker Compose
  • Clones/updates the repository
  • Creates production environment configuration
  • Builds and deploys containers
  • Optionally configures Nginx reverse proxy
  • Optionally sets up UFW firewall
  • Provides deployment summary and next steps

• scripts/verify-deployment.sh: Comprehensive verification script that:

  • Checks Docker and Docker Compose installation
  • Verifies container is running
  • Tests application health endpoint
  • Tests API Level 0 endpoint
  • Checks Swagger UI accessibility
  • Verifies port accessibility
  • Monitors system resources
  • Checks Nginx, SSL, and firewall configuration
  • Generates deployment health report

• README.md: Added Mikrus VPS deployment section with quick-deploy command and link to detailed guide

Implementation Details

• Scripts use color-coded output for better readability
• Error handling with set -e to fail fast on errors
• Configurable via environment variables (REPO_URL, BRANCH, APP_PORT, MATURITY_LEVEL)
• Non-interactive defaults with optional interactive prompts for Nginx and firewall setup
• Comprehensive logging and status reporting
• Verification script provides actionable feedback and troubleshooting guidance

Benefits

• Enables users to self-host on affordable Mikrus VPS infrastructure (~10-25 PLN/month)
• Reduces deployment friction with automated setup scripts
• Provides production-ready configuration with reverse proxy and SSL support
• Includes monitoring and verification tools for deployment validation

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!