How chukwuka1488/edupathfinder works
Project Type and Purpose
• This is a full-stack web application called “Edu Path Finder.”
• Frontend: static single-page UI built with HTML/CSS (Tailwind), vanilla JavaScript, served by Nginx in a Docker container.
• Backend: Python Flask REST API (app.py) exposing course and degree endpoints, layered into Resources → Services → Data access.
• Data Store: Azure Cosmos DB (Mongo API) seeded from large JSON files via scripts.
• DevOps: Azure Pipelines for CI/CD, Terraform for infra provisioning (Cosmos DB account, key‐vault policies, etc.), Docker Compose to orchestrate local containers.
Main Components
A. Browser / Client Application
B. Static Asset Server (Nginx container)
C. Frontend Application (HTML/JS/Tailwind)
D. Backend API Server (Flask container)
E. Business-Logic Layer (Service classes)
F. Data-Access Layer (Cosmos Mongo DB abstraction)
G. Database (Azure Cosmos DB)
H. Infrastructure Provisioning (Terraform scripts)
I. CI/CD Pipeline (Azure Pipelines YAML files)
J. Secrets Management (Azure Key Vault)
Relationships and Data Flows
1. User opens UI in Browser → requests index.html and JS/CSS assets from Nginx.
2. JS in Browser (fetchData.js, renderCourseTable.js, etc.) calls Flask REST endpoints (e.g., /courses, /degrees).
3. Flask Resources (college_degree_resource.py, course_resource.py) receive HTTP requests.
4. Resources delegate to Services (college_degree_service.py, course_service.py) implementing business logic.
5. Services call Data-Access classes (cosmos_mongo_db.py) to query/update Azure Cosmos DB.
7. Terraform scripts (backend/terraform/*.tf) provision Cosmos DB account and supporting infra in Azure.
8. Azure Pipelines (azure-pipelines.yml) build Docker images for frontend/backend, run tests, apply Terraform, and deploy containers to Azure.
9. Secrets (COSMOSDB connection strings, Azure AD credentials) are stored in Azure Key Vault and injected into containers at runtime.
Architectural Patterns and Principles
• Layered Architecture: Presentation (Resources) → Business Logic (Services) → Data Access (DB scripts).
• SOLID Principles: Each module (Resource, Service, DAO) has a single responsibility; clear abstractions between layers; dependency inversion via injecting config and DAOs into services.
• Infrastructure as Code (Terraform) and CI/CD automation (Azure Pipelines).
Key Technologies and Frameworks
• Frontend: HTML, Tailwind CSS, vanilla JS, Nginx, Docker.
• Backend: Python 3, Flask, Flask-RESTful, Pydantic (for config?), Docker.
• Database: Azure Cosmos DB with Mongo API.
• Infra: Terraform, Azure CLI, Azure Key Vault.
• CI/CD: Azure DevOps Pipelines.