Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/AngelZurita28/VeranoRegional/llms.txt

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

Institutions, campuses, and careers form the organizational backbone of Verano Regional. Every user account, research project, and student application is linked to a campus, which in turn belongs to an institution. Email domains configured on each campus also determine which addresses are accepted during user registration.
Institution management is restricted to admins (role 1). Campus and career management is available to admins (role 1) and institutional coordinators (role 2), who are automatically scoped to their own institution.

Institutions

An institution represents a university or research body participating in the program. Each institution has a unique name, an optional abbreviation, a home state, an official contact email, and an email domain.

Institution fields

FieldDescription
descriptionFull institution name (must be unique)
abbreviationShort identifier, e.g. UNAM
idStateHome state of the institution
institutional_emailOfficial contact email address for the institution
domainEmail domain associated with the institution (e.g. unam.mx)

Managing institutions

1

Open the institution list

Navigate to Manage Institutions (?action=manage_institutions). You can filter the list by name or state.
2

Add an institution

Click Add institution to open the registration form (?action=show_add_institution_form). Fill in the name, abbreviation, state, and institutional email, then submit. The platform calls InstitutionController::createInstitution, which validates all fields and rejects duplicate names.
3

Edit an institution

Click Edit next to an institution to open the edit form (?action=show_edit_institution_form&id=). You can update all fields including the domain value. Submit to call InstitutionController::updateInstitution.

Institution routes

Route actionController methodDescription
manage_institutionsshowInstitutionListPaginated list with name and state filters
show_add_institution_formshowAddInstitutionFormRegistration form
create_institutioncreateInstitutionPOST handler — creates the record
show_edit_institution_formshowEditInstitutionFormEdit form for an existing institution
update_institutionupdateInstitutionPOST handler — updates the record

Campuses

A campus belongs to one institution and is located in a specific city. Each campus can have one or more email domains that gate user registration.

Campus fields

FieldDescription
descriptionFull campus name
campusAbbreviationShort identifier for the campus
idInstitutionParent institution
idCityCity where the campus is located (cascades to state)
domainsOne or more email domains allowed for user registration on this campus

Managing campuses

1

Open the campus list

Navigate to Manage Campus (?action=manage_campus). Institutional coordinators only see campuses belonging to their institution.
2

Add a campus

Click Add campus (?action=show_add_campus_form). Select the parent institution, then choose a state and city. Add one or more email domains using the domain fields. Submit to call CampusController::createCampus.
3

Edit a campus

Click Edit (?action=show_edit_campus_form&id=). You can update the name, abbreviation, city, and domain list. Institutional coordinators are blocked from editing campuses outside their institution.

Campus routes

Route actionController methodDescription
manage_campusshowCampusListPaginated list with name and institution filters
show_add_campus_formshowAddCampusFormRegistration form
create_campuscreateCampusPOST handler — creates the record
show_edit_campus_formshowEditCampusFormEdit form for an existing campus
update_campusupdateCampusPOST handler — updates the record

Academic careers

Careers are degree programs attached to a specific campus. Students select a career at registration time and their careerProgressPercentage is validated against the project’s minimum requirement.

Managing careers

1

Open the career list

Navigate to Manage Careers (?action=manage_campus_careers). Filter by campus or institution.
2

Add a career

Click Add career (?action=show_add_career_form). Select the parent campus and enter the career name. Submit to call CareerController::createCareer.
3

Edit a career

Click Edit (?action=show_edit_career_form&id=). Update the name or reassign to a different campus, then submit to call CareerController::updateCareer.

Career routes

Route actionController methodDescription
manage_campus_careersshowCareerListCareer list with campus filter
show_add_career_formshowAddCareerFormRegistration form
create_careercreateCareerPOST handler — creates the record
show_edit_career_formshowEditCareerFormEdit form for an existing career
update_careerupdateCareerPOST handler — updates the record

Email domain configuration

Each campus stores a list of allowed email domains. When a coordinator registers a new user or when a user self-registers, the platform constructs the full email address from the username part and a domain selected from the campus’s domain list.
Use specific institutional domains (e.g. uas.edu.mx) rather than generic providers to ensure only authorized users can register for each campus. If no domain is configured for a campus, the platform falls back to gmail.com.
Domains are managed through the campus edit form. Add or remove domain entries before saving. The domain field on the institution record is separate and used for institutional-level contact information, not for registration validation.

Build docs developers (and LLMs) love