How bellwin98/be-pinup works
Project type and purpose
• This is a Java Spring Boot–based RESTful backend for “PIN UP,” a map-centric private social network. It exposes HTTP APIs for a frontend/mobile client, handles authentication (OAuth2 + JWT + Redis), stores domain data (places, reviews, bookmarks, friends, alarms), and integrates with external services (Kakao Map API, OAuth providers, AWS S3).
File structure
• Top-level artifacts:
• Dockerfile, docker-compose.yml, GitHub workflows → containerization & CI/CD
• build.gradle, gradlew → Gradle build
• src/main/java/com/pinup: layered by domain feature (alarm, article, bookmark, friend, home, member, place, review) plus global/config/exception/response.
• src/main/resources/application.yml, data.sql → DB & infra config
• src/test → unit tests for core domains
• Architectural patterns:
• Layered MVC-style (Controller → Service → Repository → Entity)
• External integration modules under global/config (Kakao, S3, Redis, JWT)
• SSE for real-time alarms
• QueryDSL for advanced queries
Key insights from README
• Uses: MariaDB (primary RDBMS), Redis (caching & token store), AWS S3 (image storage), Kakao Map API (place lookup), OAuth2 social login, Swagger for docs.
• CI/CD: Docker, GitHub Actions → automated build & deploy
Essential architectural elements to capture
• Authentication & token flow (OAuth2 → JWT → Redis)
• Lookup & clustering logic (Kakao → DB → QueryDSL)
• Notification pipeline (Service → SSE emitter → Client)
• Image storage flow (Client → API → S3 → DB)
• Data persistence boundaries (JPA → MariaDB; Redis as cache & store)
• DevOps pipeline (GitHub Actions → Docker image → Deployment)