How kae-tempest/tempestboard works
• Frontend: Represent the Nuxt.js application (located under the “front” folder). Note that this includes components, pages, plugins, and global configuration that define the client-side logic and UI.
• Backend: Represent the Django application (in the “back” folder). Highlight the “TempestBoard” module (with files like asgi.py, settings.py, urls.py, wsgi.py) and the “core” module that houses business logic, models, views, serializers, and API endpoints.
• Database: Represent PostgreSQL (as indicated by the “docker/postgresql” configuration and README badges). Indicate that it supports data persistence for the Django application.
• Docker & Deployment: Illustrate the Docker containerization and orchestration elements (Dockerfiles in both “front” and “back”, docker-compose files (compose.yml, compose-prod.yml), and CI/CD workflows under “.github/workflows”). These convey how the application is built, deployed, and maintained.
Detail the Relationships and Data Flow
• Backend to the Database to illustrate data interactions such as migrations (as suggested in the README) and query handling.
• If applicable, indicate any real-time or websocket communication (hinted at by the presence of Django consumers in “back/core/consumers.py” and composable “useWebSocket.ts” in the frontend).
Architectural Patterns & Design Principles
• For a Full-Stack application:
• Separation of concerns (clear distinction between frontend and backend).
• RESTful or possibly WebSocket-based API layers that connect these components.
• Containerization principle where each part (frontend, backend, database) is encapsulated within its own Docker container.
• The modular structure of Django (with an “apps” focus, as seen in “back/core/”) and Nuxt (organized components, pages, plugins) should be noted for extensibility.
Relevant Tools & Technologies
• Frontend: Nuxt.js (Vue.js framework), various Vue components, state management (likely via Pinia as seen in “front/stores/useUserStore.ts” and plugins).
• Backend: Django for processing business logic, API endpoints, and handling authentication, migrations (illustrated by “manage.py” and the “migrations” folder).
• Database: PostgreSQL (with Docker configuration scripts provided).
• CI/CD: GitHub workflows (for continuous deployment/integration) and Docker orchestration.
• Design: Reference the Figma mockup provided in the README for UI design context.