Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/GuillermoNavarro/Proyecto_comunidades/llms.txt

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

Comunidades Vecinos is an open-source web application that gives homeowners communities full control over their self-governance. Built on a Spring Boot REST API and a React frontend, it provides role-based access for residents, administrators, and platform operators — covering everything from fee collection and receipt tracking to document storage and community announcements.

Quick Start

Deploy the backend and frontend and log in for the first time in minutes.

Architecture

Understand the full-stack structure, roles, and data model.

Core Features

Explore communities, users, fees, finances, documents, and announcements.

API Reference

Browse every REST endpoint with request/response schemas and examples.

What you can do

Comunidades Vecinos covers the complete lifecycle of managing a residential community:

Fee Management

Create ordinary, extraordinary, and individual fees. Receipts are automatically generated for each resident.

Financial Ledger

Track income and expenses for each community with a full movement history.

Document Storage

Upload and share PDF documents scoped to each community.

Announcements

Post news and notices visible to all members of a community.

User Management

Manage residents and administrators with three fine-grained roles.

Multi-Community

A single platform operator account manages multiple independent communities.

How it works

1

Deploy the backend

Configure your MariaDB database and environment variables, then start the Spring Boot API on port 8081.
2

Deploy the frontend

Build the React app with Vite and serve the static output behind a reverse proxy pointed at the API.
3

Create your first community

Log in as SUPER_ADMIN, create a community, then add an ADMIN user who will manage it day-to-day.
4

Invite residents

The community ADMIN creates resident accounts. Each resident receives a temporary password and is prompted to change it on first login.
The REST API is fully documented with Swagger UI. Once the backend is running, visit http://localhost:8081/swagger-ui/index.html to explore all endpoints interactively.

Build docs developers (and LLMs) love