How woowacourse-teams/2024-pengcook works
Project Type and Purpose
• PengCook is a full-stack social-media application for sharing and discovering recipes.
• It comprises:
• Android mobile client (Kotlin)
• Java/Spring-Boot backend API
• Persistent storage (relational database)
• Documentation and CI/CD workflows
File-Structure Analysis
• Top-level directories:
• android/ – Android app source
• backend/ – Spring Boot service
• docs/ – Markdown docs (architecture, user guide)
• .github/ – issue templates and CI workflows
• Patterns & conventions:
• android/ likely follows MVVM or MVP with Retrofit for REST calls
• backend/ likely uses MVC (Controllers → Services → Repositories)
• CI workflows automate builds/tests for both client & server
Insights from README
• Tech stack badges confirm Android/Kotlin client and Java/Spring backend
• Feature set: home feed, search, categories, profiles, recipe posting, step-by-step views
a. Main Components
• Android Mobile App
• API Gateway / Load Balancer (optional)
• Spring Boot Backend
• Relational Database (e.g., MySQL/PostgreSQL)
• External Services (e.g., Instagram/YouTube analytics or OAuth)
b. Relationships & Data Flow
1. User taps in Android → ViewModel issues Retrofit call
2. Request hits API Gateway → routed to Spring Boot Controller
3. Controller invokes Service layer → Repository layer → Database
4. Response bubbles back through Service → Controller → mobile client
5. Optional: Backend pushes notifications or media to external social-media APIs
c. Architectural Patterns
• Android: MVVM (Activity/Fragment ↔ ViewModel ↔ Repository)
• Backend: Layered (Controller → Service → Repository)
• RESTful API, JSON over HTTPS
• Transactional boundaries at service methods
d. Key Technologies
• Android: Kotlin, Jetpack, Retrofit, Room or direct SQL?
• Backend: Spring Boot, Spring Data JPA, H2/MySQL, Swagger/OpenAPI for docs
• CI/CD: GitHub Actions for building & testing
Diagramming Recommendations
• Client components (blue rectangles)
• Server components (green rectangles)
• External services (gray clouds)
• Related components within containers (e.g., “Android App Module”)
• Asynchronous flows (e.g., push notifications)