Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Luisanchez0/modulo_Horario/llms.txt

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

Módulo Horario is a full-stack academic scheduling platform built on four independent FastAPI microservices. It handles teacher management, subject and classroom catalogs, and intelligently generates conflict-free weekly schedules respecting teacher availability and shift constraints.

Quick start

Get the system running locally with Docker in under five minutes.

Architecture

Understand the four microservices and how they communicate.

Schedule management

Learn how automatic schedule generation works.

API reference

Explore the full REST API for all four services.

​
What you can do

Manage teachers

Create, update, and set availability and shift preferences for teachers.

Catalog subjects & classrooms

Maintain the subject catalog and classroom inventory with capacity info.

Academic periods

Define semester or trimester periods that schedules are tied to.

Calendar & PDF export

View schedules in an interactive calendar and export them to PDF.

​
Get started

1

Clone the repository and generate secrets

git clone https://github.com/Luisanchez0/modulo_Horario.git
cd modulo_Horario
bash setup-secrets.sh
2

Start backend services with Docker Compose

cd services
docker compose up --build
Four services start on ports 8001–8004. Verify with curl http://localhost:8001/health.
3

Start the React frontend

cd ../frontend
npm install
npm run dev
Open http://localhost:5173 and log in with [email protected] / 1234.
4

Generate your first schedule

Navigate to Horarios, choose a period, and click Generate to let the algorithm create a complete conflict-free timetable.
The default credentials ([email protected] / 1234) are for development only. Rotate all secrets before deploying to production — see the Security guide.

Build docs developers (and LLMs) love

Get started for freeTalk to us