How wester35/yadro-test-task works
Project type and purpose
• This is a full-stack Django web application packaged with Docker Compose.
• It provides a UI (HTML templates) to load user data from an external API into a PostgreSQL database, list users in a paginated table, and view individual or random user details.
File structure
• Top‐level “task/” directory contains:
– Docker-related files: Dockerfile, .dockerignore, docker-compose.yml
– manage.py, pytest.ini, requirements.txt
– Django project folder “task/task/” with settings, ASGI/WGI, URLs
– Two Django apps:
• api/ — models, views (REST endpoints?), load_users script, tests
• frontend/ — views, templates, URL routing, tables, tests
– templates/frontend/ — index.html, user_detail.html
• docker-compose.yml defines two services: “web” (Django container) and “db” (PostgreSQL).
README for additional insights
• The app listens on port 8008, auto-runs pytest on startup.
• Explains how to spin up Docker Compose, run migrations, create superusers.
• Describes three user‐facing pages (main list, individual user, random user).
a. Main components
– Browser (client)
– Docker Compose orchestrator
– “web” container:
• Django project (Monolithic container)
· URL router (task/urls.py)
· Frontend app (views → templates → HTTP responses)
· API app (management command load_users, models, internal REST/API endpoints)
· ORM models → PostgreSQL
· Signals (e.g., post_save hooks)
– “db” container (PostgreSQL)
– External User API (third-party service from which load_users fetches data)
b. Relationships & data flow
1. Browser issues HTTP requests → web container (port 8008).
2. Django URL router dispatches to:
• Frontend.views → templates for rendering HTML
• API.load_users (management command invoked by user action or CI)
3. Django ORM issues SQL queries → PostgreSQL container.
4. load_users script issues HTTPS calls → External User API → returns JSON → parsed → ORM → DB.
5. Tests (pytest) run inside web container against both apps.
c. Architectural patterns / design principles
• Layered MVC (models, views, templates)
• Monolith container with two logical modules (api and frontend)
• External-service integration (the user data API)
• Infrastructure as code (Dockerfile, docker-compose.yml)
d. Relevant technologies / frameworks
• Python 3.x, Django
• Docker, Docker Compose
• PostgreSQL
• pytest (testing)
• Django ORM, Django signals
Detail
– URL Dispatcher
– frontend/views.py → templates
– api/load_users.py & api/views.py
– models.py (shared by both apps)
– signals.py
• That docker-compose.yml wires “web” and “db” with a named Docker network.
• Commands triggered on startup (pytest, migrations).