Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Elian-D/ORVIAN/llms.txt

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

ORVIAN is a full-stack school management platform built on Laravel 12 for Dominican educational institutions. It unifies attendance tracking (facial recognition, QR, and manual), academic administration, student enrollment, teacher assignments, and WhatsApp alert communications — all within a multi-tenant architecture where every school operates in complete isolation.

Quick Start

Clone the repo, run composer setup, and have ORVIAN running locally in under five minutes.

Architecture

Understand the modular monolith, multi-tenant isolation, Livewire patterns, and service layer design.

Attendance Module

Track campus and classroom attendance with three recording methods and cross-validation rules.

Academic Module

Manage students, teachers, course sections, subjects, and enrollment workflows.

Deployment

Deploy with Docker Compose (Laravel Sail), configure environment variables, and run in production.

Integrations

Connect the optional Python biometric microservice, WhatsApp alerts, and Chatwoot messaging.

What ORVIAN Does

Dual Attendance

Campus-level (Plantel) and classroom-level attendance with strict cross-validation to detect hall-wandering (“pasilleo”).

Three Recording Methods

Facial recognition, physical QR wristband scan, or manual roll call — all from a single interface.

Multi-Tenant Isolation

Each school’s data is fully isolated. Middleware resolves tenant context automatically on every request.

Role-Based Access

Granular permissions via Spatie Permissions. Roles are cloned per school so every institution controls its own access model.

WhatsApp Alerts

Automatic absence and tardiness notifications to tutors via Evolution API with configurable thresholds.

Excel Import & PDF Export

Bulk-import students from SIGERD-formatted Excel files. Export attendance reports and academic records to PDF.

Getting Started

1

Clone and configure

Clone the repository and copy .env.example to .env. Set your APP_URL, database credentials, and optional third-party service keys.
2

Run the setup script

Execute composer setup to install PHP and Node dependencies, generate an application key, run migrations, and build frontend assets.
3

Start the development server

Run composer dev to start the Laravel server, queue worker, log tail, and Vite dev server concurrently.
4

Complete the Owner onboarding

Visit /register to create the first Owner account and set up the platform. Then use the school wizard to configure your first educational institution.
ORVIAN is licensed under AGPL-3.0. The optional facial recognition microservice lives in a separate repository (orvian-facial-recognition) and requires Python with FastAPI.

Build docs developers (and LLMs) love