Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CristianRR94/springCommunity/llms.txt

Use this file to discover all available pages before exploring further.

Spring Community is a production-ready backend API built with Spring Boot 4 that powers community platforms. It handles user accounts, community events with image uploads, a participant social graph with friend relationships, and real-time event chat over WebSockets — all secured with stateless JWT authentication.

Quickstart

Make your first API call in minutes — register, authenticate, and create an event.

API Reference

Full endpoint documentation with request/response schemas and curl examples.

Authentication

Learn how JWT access and refresh tokens work and how to pass them in requests.

Deployment

Deploy with Docker Compose including PostgreSQL in minutes.

What Spring Community provides

Spring Community exposes a REST API that your frontend or mobile app can consume. The backend manages the full lifecycle of community events, participant profiles, and in-event chat rooms.

Event Management

Create, update, and delete community events with optional image uploads, privacy controls, and participant caps.

Social Graph

Participants can add friends, browse other users, and track their event memberships and admin roles.

Real-Time Chat

Every event has its own STOMP-over-WebSocket chat room with a persisted message history.

JWT Auth

Stateless access + refresh token rotation with per-token revocation stored in the database.

Image Storage

Upload event banners and participant avatars via multipart requests; served from local storage.

Docker Ready

A Docker Compose file wires the Spring Boot app to PostgreSQL 15 for instant local development.

Getting started

1

Clone and configure

Clone the repository and set the required environment variables (JWT_SECRET, DB_PASSWORD).
2

Start with Docker Compose

Run docker compose up to start the API and a PostgreSQL 15 instance together.
3

Register and authenticate

POST /auth/crear to create your first account, then POST /auth/login to receive a JWT token pair.
4

Explore the API

Use the token in Authorization: Bearer <token> headers to access events, participants, and chat endpoints.
Spring Community is designed to be consumed by an Angular frontend. The CORS configuration permits http://localhost:4200 by default — update WebSecurityConfig for production origins.

Build docs developers (and LLMs) love