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 full-featured school management application built with Flutter, designed to serve every stakeholder in a school ecosystem — from super-administrators managing multiple institutions, to directors, teachers, students, and parents — each with their own role-based dashboard and feature set.

Quickstart

Set up the project and run your first build in minutes.

Architecture

Understand the feature-based project structure and data flow.

Authentication

Learn how JWT-based authentication and role management work.

API Reference

Explore every REST endpoint used by the Flutter app.

What Mi Cole Does

Mi Cole connects all participants in a school’s daily operations through a single, unified app. The platform is multi-tenant by design — a super-admin creates and configures schools, each with its own director, staff, and student body.

School Administration

Manage schools, academic periods, courses, sections, subjects, and enrollments.

Teacher Tools

Class dashboards with attendance, agenda/tasks, grade book, and student anecdotes.

Student Portal

View schedules, subjects, pending assignments, library resources, and exams.

Parent Portal

Track children’s grades, attendance records, agenda items, and anecdotario entries.

Circulars

Send targeted announcements to specific roles across the school community.

Developer Guide

Dive into the codebase — Dio client, Provider state, GoRouter configuration.

Getting Started

1

Clone the repository

Clone the Flutter project and install dependencies with flutter pub get.
2

Configure the API base URL

Update the baseUrl in lib/core/dio/dio_client.dart to point to your backend server.
3

Run the app

Launch on your target platform with flutter run. The app opens on the login screen and redirects based on your role after authentication.
4

Explore the docs

Follow the Quickstart guide for a complete walkthrough, or jump straight to the Features section for a tour of each module.

Build docs developers (and LLMs) love