How teamsphereco/teamsphere-api works
Project type and purpose
• This is the backend service of Teamsphere, a chat application built with Spring Boot. It handles user authentication (JWT with Spring Security), one-on-one chat, profile image storage (Cloudflare Images), and sets the foundation for future group chat via STOMP over RabbitMQ. It’s packaged as a Docker container and orchestrated alongside MySQL, RabbitMQ, and an observability stack (Grafana, Loki, Promtail).
File structure
• Top-level “backend-service” contains a classic layered Spring Boot app:
• config (JWT, WebSocket, CORS, AppProperties)
• controllers (REST & WebSocket endpoints)
• services & impl (business logic)
• repository (Spring Data JPA)
• models (JPA entities)
• DTO & mappers (API payload mapping)
• filters (request logging, correlation IDs)
• Resources hold multiple YAML profiles (dev, local, prod) and bootstrap configuration.
• Root contains Docker Compose (mysql, rabbitmq), observability config folders (grafana, loki, promtail), and a Dockerfile under /images.
• CI pipelines live in .github/workflows.
Extract key architectural insights from README
• REST API for chat, JWT-secured endpoints
• STOMP/WebSocket support planned for group chat
• External dependencies: MySQL, RabbitMQ, Cloudflare Images
• Deployed on DigitalOcean via Docker Compose
• Observability via Loki/Promtail (logs) and Grafana (dashboards)
Key reminders
• Be exhaustive but avoid clutter—group closely related classes under layer containers.
• External dependencies and data flows.