Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/luiss811/Backend-Airguide/llms.txt

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

AirGuide Backend is a production-ready microservices API built with Node.js, Express, and Prisma. It provides everything needed to build a university campus navigation experience — from authenticated user sessions and building directories to AI-powered event scheduling and real-time congestion prediction for campus routes.

Quickstart

Make your first authenticated API call in minutes

Architecture

Understand the microservices layout and gateway routing

API Reference

Full endpoint reference with request and response schemas

Authentication

Learn how JWT tokens and 2FA work end to end

What AirGuide provides

AirGuide’s backend is organized into five independent services, each with a focused responsibility:

Auth Service

User registration, 2FA via email OTP, JWT issuance, and admin approval workflows

Buildings Service

CRUD management for campus buildings, classrooms, professor cubicles, and occupancy data

Events Service

Event creation with AI-powered scheduling conflict resolution and QR attendance confirmation

Navigation Service

Turn-by-turn campus routes, GeoJSON map data, Google Routes integration, and congestion heatmaps

Analytics Service

Admin dashboard with route usage, access logs, user breakdowns, and AI model training

Configuration

Environment variables, database setup, and deployment options

Key capabilities

  • Two-factor authentication — Login is a two-step flow: credentials + email OTP before a JWT is issued
  • Role-based access control — Four roles (rector, admin, profesor, alumno) with an admin approval step for new accounts
  • AI event scheduling — TensorFlow.js neural network evaluates event conflicts and can displace lower-priority events
  • Campus routing — Pre-seeded turn-by-turn routes with waypoint coordinates, plus live Google Routes API integration for walking directions
  • Congestion prediction — Per-route AI model predicts congestion score by hour; global heatmap endpoint available
  • GeoJSON map data — Combined endpoint returns campus buildings (points) and walkable paths (LineStrings) for map rendering

Base URL

All requests go through the API Gateway on port 3001:
http://localhost:3001
Each microservice also runs on its own port for direct access during development:
ServicePort
API Gateway3001
Auth Service3011
Buildings Service3012
Events Service3013
Navigation Service3014
Analytics Service3015

Build docs developers (and LLMs) love