How woowacourse-teams/2023-votogether works
Main System Components
• Database: Indicate a persistent storage system that the backend connects to. Although the file tree does not explicitly list a database, the presence of repository classes implies a database (likely relational).
• External Services: Identify components such as external OAuth (e.g., Kakao authentication client) and integration with Slack (as evidenced by the GitHub workflow scripts and Slack appender configuration). Also, include Redis (configured via RedisConfig) and image uploading services from the “infra/image” package.
• CI/CD Pipeline: Represent the GitHub workflows as part of the development process to illustrate automated testing, PR checks, and deployment pipelines for both the backend and frontend components.
Relationships and Data Flows
• How user interactions on the Frontend send REST API requests to the Backend Server.
• In the Backend, show flow: requests reach Controllers → invoke Service layer → call Repository/Data Access Objects for CRUD operations.
• Integration points for logging (global log config and log interceptor classes) and error handling through global exception handling modules.
Architectural Patterns and Key Details
• The Backend follows a modular “domain-driven design”, where each domain (alarm, auth, etc.) is separated into its own package with controller, DTO, service, entity, repository, and exception handling subpackages.
• The Frontend uses component-based design with Storybook for UI component development, and it includes both unit and end-to-end testing using Jest and Cypress.
• Use of middleware such as JWT authentication filters and OAuth integration.
• That CI/CD processes help ensure code quality with distinct workflows for pull requests, testing, and deployment (including lighthouse for frontend performance).