Skip to content

Infrastructure Overview

This document outlines the local and deployment infrastructure for the project.

🚀 Setup Instructions

  1. Clone the repository and navigate to the project root.
  2. Copy .env.example to .env and update environment variables as needed.
  3. Run docker-compose up --build to start backend, database, and frontend containers.
  4. Access local monitoring dashboards (Prometheus, Grafana, Loki) at the provided ports.
  5. Use scripts in /infra/scripts for setup, testing, and deployment automation.

🗺️ Architecture Diagram

🛠️ Local Development

  • Use Docker Compose to run backend, database, and (optionally) frontend.
  • Environment variables stored in .env files.
  • Scripts in /infra/scripts for setup, testing, and deployment.
  • Example local monitoring: Prometheus, Grafana, Loki.
  • For detailed on-premises development options, see On-Premises Development.

🚢 Deployment

  • Containerized deployment using Docker images.
  • Future: Kubernetes manifests for scaling.
  • Deployment pipeline: GitHub Actions for CI/CD (build, test, deploy).
  • Monitoring/alerting: Prometheus, Grafana, and alertmanager.

🤖 Automation

  • Use Makefile for common tasks (dev, test, lint, build).
  • GitHub Actions or similar for CI/CD.
  • Cost management: Monitor resource usage and optimize Docker images.

🧩 Troubleshooting

  • Ensure Docker and Docker Compose are installed and running.
  • Check .env configuration for missing or incorrect values.
  • Use docker-compose logs to view service logs.
  • For monitoring issues, verify Prometheus and Grafana containers are healthy.
  • See scripts-readme.md for automation script usage.

Update as your infra grows. Reference the documentation standards for best practices.