How julianz-cd/uwvault works
Main Components
• Frontend Layer: Represent your Next.js client that includes numerous pages, components, hooks, and tests. This layer is responsible for rendering the UI for user authentication, resource management, course details, and other features.
• Storage Layer: Show the persistence mechanism:
• PostgreSQL for user data, course information, and resource metadata.
• ElasticSearch for document indexing and course search functionalities.
• GCP Cloud Storage to handle file storage for course documents and additional resource files.
• CI/CD Pipeline: Demonstrate how GitHub workflows trigger tests, builds, and the container registry, which then deploy the built images into your infrastructure.
• Infrastructure: Include Docker for containerization and the cloud hosting environment (GCP Compute Engine) that runs your containers and storage services.
Detail the Relationships and Interactions
• Backend to Storage: Connect the backend services (e.g., auth, resource, course) to the storage components, showing how data operations (CRUD operations) and search queries are handled.
• Infrastructure Integration: Show that Docker containers and GCP Compute Engine host both the backend services and databases (PostgreSQL, ElasticSearch, Cloud Storage).
Architectural Patterns and Design Principles
• Modularity: Emphasize the separation of concerns between the frontend and backend. Each API service (organized under /api/services) is well isolated.
• Routing and Rewrites: The Next.js configuration employs rewrites to seamlessly integrate FastAPI endpoints into the same domain.
• Testing: Note the thorough testing infrastructure with unit, integration, and end-to-end tests in both API and app directories.
• CI/CD Automation: The use of GitHub workflows ensures continuous integration and smooth deployment flow.
Relevant Technologies & Frameworks
• Frontend: Next.js, React, Tailwind CSS.
• Backend: Python, FastAPI.
• Databases & Storage: PostgreSQL, ElasticSearch, GCP Cloud Storage.
• Additional Tooling: Docker, GitHub Actions, ESLint, PyTest, and various testing frameworks for both backend and frontend.
Putting It All Together
• Next, isolate your “Frontend” and “Backend” clusters, clearly showing the Next.js app in one cluster and the FastAPI services in the other.