How capstonedesign-taxicarpool/team_be works
Project Type and Purpose
• This is a Java Spring Boot–based backend (monolithic) application named “taxi-carpool.”
• It provides RESTful and WebSocket APIs for a taxi‐carpooling service, handling user management, authentication (JWT), chat, party (ride grouping), email verification, and external map lookups (Kakao API).
File Structure Analysis
• Top‐level: “taxi-carpool” Gradle project with standard Spring Boot layout:
• src/main/java/…/taxicarpool – root package
• Subpackages by feature: auth, chatting, config, email, exception, map, member, party
• src/main/resources – application.properties (profiles)
• src/test – unit/integration tests
• MVC / layered pattern:
• Controllers (API endpoints)
• Services (business logic)
• Repositories (Spring Data JPA interfaces)
• Entities, DTOs, Mappers
• Configuration classes: SecurityConfig, SwaggerConfig, WebSocketConfig
• Build & CI: Gradle wrapper, GitHub Actions workflow
Key Architecture Points from README
• README only gives project name (“team_BE”); details inferred from structure and naming.
a. Main Components
• External Clients: Web/Mobile Apps
• API Layer: REST Controllers & WebSocket Endpoints
• Business Layer: AuthService, MemberService, PartyService, MapService, EmailService, ChatService
• Data Layer: Repositories → Relational Database (e.g., PostgreSQL/MySQL)
• Cross‐cutting/Config: SecurityConfig (JWT filter), WebSocketConfig, SwaggerConfig
• External Dependencies:
• Kakao Map API (HTTP)
• SMTP server (Email)
b. Relationships & Interactions
• Clients → HTTP(S) → AuthController / MemberController / PartyController / MapController / EmailVerificationController
• Clients → WebSocket → Chat endpoint (MessageEntity flow)
• Controllers call Services → Services call Repositories → Database
• AuthService issues JWTs and stores RefreshTokenEntity
• EmailService sends verification codes via SMTP
• MapService calls external Kakao API, parses MapPlaceDTO
c. Architectural Patterns & Principles
• Layered (Controller → Service → Repository)
• Feature grouping by package
• JWT‐based stateless authentication
• WebSocket for real‐time chat
• Exception‐handling via GlobalExceptionHandler
d. Technologies & Frameworks
• Spring Boot (Web, Data JPA, Security, WebSocket)
• Gradle build system
• JWT (via custom JwtUtil, filter)
• Swagger for API docs
• Kakao REST API integration
• SMTP for email