Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/fredy-rizo/gestor-backend/llms.txt

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

Gestor Deportivo is a backend REST API that powers the full lifecycle of sports tournament management. From registering users and building team rosters to scheduling matches, recording live match events, and generating automatic standings tables — this API covers everything a tournament organizer needs.

Quickstart

Get the server running locally and make your first API call in minutes.

Configuration

Set up environment variables for the database, JWT secret, email, and Google Cloud Storage.

API Reference

Explore every endpoint — auth, teams, players, events, games, clubs, and more.

Guides

Step-by-step walkthroughs for the most common workflows.

What you can build

Gestor Deportivo provides all the building blocks for a complete sports tournament platform:

User Accounts

Registration with email verification, JWT login, role management, and membership plans.

Teams & Clubs

Create teams, manage rosters, group teams into clubs, and handle player transfers.

Tournaments

Run championships with knockout or group-stage formats, set dates, locations, and categories.

Live Match Data

Record goals, cards (yellow/red/blue), fouls, substitutions, and match results in real time.

Standings Tables

Automatically computed classification tables and top-scorer lists per event.

News & Notices

Publish news articles and updates tied to specific events or shown on the home feed.

Get started

1

Clone & install

Clone the repository and install dependencies with npm install.
2

Configure environment

Create a .env file with your MongoDB URL, JWT secret, email credentials, and Google Cloud Storage keys. See Configuration for all required variables.
3

Start the server

Run npm run dev to start the API in development mode with hot reload.
4

Register & authenticate

Call POST /api/user/register to create an account, verify it by email, then log in to receive your JWT token. See Authentication for details.

Core concepts

Authentication

How JWT tokens work, where to pass them, and how account verification flows operate.

Pagination

All list endpoints use a consistent pagination pattern via URL params and request body.

File Uploads

Upload avatars, team images, and event banners using multipart form data to Google Cloud Storage.

Membership Plans

Plan limits control how many teams, events, and matches each user can create.

Build docs developers (and LLMs) love