Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/andrespaul123/micole-flutter/llms.txt

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

Mi Cole is a cross-platform school management system built with Flutter 3. It connects every stakeholder in a school — from the super-admin who provisions institutions, to the director who manages staff and curriculum, to the teacher, student, and parent who interact with day-to-day academic life — through a single, unified mobile and web application backed by a shared REST API.

What Mi Cole Does

Mi Cole operates as a multi-tenant SaaS: each school (tenant) gets its own isolated data space while sharing the same Flutter client. After a user logs in, the app reads their role from the JWT response and renders the correct dashboard automatically. No manual environment switching is required.

Multi-Tenant Architecture

Each school is an independent tenant. A super-admin can create, configure, and assign modules to any institution from a central console.

Role-Based Dashboards

Five distinct roles each see a tailored UI: super-admin, director, profesor, estudiante, and padre. GoRouter enforces navigation rules per role.

Secure Authentication

JWT Bearer tokens are stored with flutter_secure_storage on mobile and shared_preferences on web. A Dio interceptor auto-attaches the token to every request and redirects on 401.

Academic Management

Directors manage teachers, students, parents, courses, subjects, academic periods, timetables, and enrollments, all from one place.

Classroom Tools

Teachers record attendance, maintain an agenda, manage a grade book (libro de calificaciones), write anecdotal notes, and share resources with students.

Student & Parent Portal

Students view their timetable, subjects, pending tasks, exams, and the library. Parents track grades, attendance, agenda entries, and anecdotes for each child.

Roles Overview

Mi Cole defines five roles that map directly to the people inside a school.
RoleSpanish LabelScope
super-adminSuper AdministradorPlatform-wide — manages all tenants
directorDirectorSingle school — manages all resources
profesorProfesorAssigned classes — attendance, grades, agenda
estudianteEstudianteOwn profile — schedule, tasks, library
padrePadre de FamiliaOwn children — grades, attendance, agenda
After a successful login the roles array returned by the API determines which routes and widgets are rendered. See Roles for a detailed capability matrix.

Tech Stack

Mi Cole is built entirely in Dart and Flutter, with a clear separation between UI and data layers.
LayerTechnologyVersion
UI FrameworkFlutterSDK ^3.7.2
LanguageDartSDK ^3.7.2
HTTP ClientDio^5.9.2
State ManagementProvider^6.1.5+1
Routinggo_router^14.0.0
Secure Storageflutter_secure_storage^10.0.0
Web Storageshared_preferences^2.5.3
Localizationsflutter_localizationsSDK bundled
File Handlingfile_picker^8.0.0
Link Openingurl_launcher^6.3.0
Mi Cole targets Android, iOS, Web, macOS, Linux, and Windows from a single codebase. Web builds use PathUrlStrategy for clean URLs (no # fragment).

Build docs developers (and LLMs) love