How zunohoang/neptune-oj works
Project Components
• Frontend: The NeptuneOJ-Client directory clearly indicates a ReactJS-based web application that users interact with.
• Backend: The NeptuneOJ-Server directory is dedicated to the Spring Boot backend. Additionally, there is a .java directory which might include shared or lower-level Java code used by the backend.
• Database: As detailed in the README, PostgreSQL is used as the primary data store.
• Caching/Message Bus: Redis is used both as a cache and a message broker.
• Containerization & Deployment: Docker support is included, so the architecture should factor in containerized components.
• (Optional) Version Control & Submodules: The .gitmodules file indicates that there might be external dependencies or linked repositories that should be considered in dependency mappings.
Relationships and Data Flow
• The Backend communicates with PostgreSQL for persistent data and with Redis for caching and queuing.
• Docker as an overarching layer depicting how these components are containerized and orchestrated.
• Optionally, if there are external dependencies (as hinted by the .gitmodules file), indicate how these integrate into the overall system.
Incorporate Architectural Patterns and Technologies
• The separation between frontend and backend should be highlighted as a key architectural decision.
• MVC-like setup on the backend, where Spring Boot handles routing, business logic, and data persistence.
• Detail the asynchronous communication or caching strategies using Redis.
• Containerization strategy using Docker which ensures consistent deployment environments.
Final Recommendations
• Be very detailed—don’t hesitate to split the system into as many individual components as possible. For example, in addition to just "Frontend" and "Backend", break the backend into API, business logic, persistence, and asynchronous processing components.
• How Docker ties these components together by showing the containerized deployment scenario.
• Inter-component communications such as REST API calls or queue-based event handling.
Happy diagramming!