Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Taykl12/Classify/llms.txt

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

Project Groups are the central unit of collaboration in Classify. Each project brings together a student owner, optional team members, and assigned professors under a shared workspace where work is tracked, documented, and reviewed. Projects move through an open-to-closed lifecycle and expose fine-grained controls so professors can lock specific sections when reviews are in progress.

​
Creating a Project

Any authenticated user can create a new project. Supply a name and, optionally, a description and an initial list of member emails. Classify calls the create_grupo_proyecto database function internally to set up the project and link the creator as owner. 
{
  "name": "Smart Irrigation System",
  "description": "An IoT-based system for automated crop irrigation using soil sensors.",
  "memberEmails": [
    "ana.garcia@university.edu",
    "luis.perez@university.edu"
  ]
}
1

Open the Projects page

Navigate to Projects in the sidebar and click New Project.
2

Fill in the project details

Enter a project name (required) and an optional description. You can invite teammates immediately by entering their email addresses.
3

Submit

Click Create Project. Classify provisions the project via create_grupo_proyecto and redirects you to the project detail view.

​
Project Status

Every project carries one of two status values.

Abierto

The project is active. Members can add tasks, upload documents, and update scope details.

Cerrado

The project has been closed. It remains visible and readable but no further edits are expected. Professors or owners can reopen a project by changing its status back to Abierto.

​
Member Management

Members are managed through their email addresses. The project owner can add or remove members at any time from the Team section of the project detail page. Each email must correspond to an existing Classify account.
  • Owner — the student who created the project (linked via proyecto_profesor). Can edit all core fields, toggle the favorite flag, and delete the project.
  • Members — students linked via grupo_estudiante. Can view all project content but cannot edit the name, description, status, or other core fields.
Professors are assigned to projects separately through course administration. An assigned professor automatically gains elevated access to the project regardless of member lists.

​
Project Configuration

Beyond the basic name and description, the project detail view exposes several configuration sections.

Objective

A free-text field describing the project’s primary goal. Edited directly in the detail view by the owner.

Scope

Two fields — Scope Detail and Scope Notes — define the boundaries of the project. This section can be locked by a professor.

Documentation

Attach named documents as URL links. Stored as a JSONB array of { nombre, url } objects in the database. The Backup Link and Grades Link fields are also part of this section.

Pre-project Validation

Professors can toggle preprojectValidated to signal that the pre-project document has been reviewed and approved.

​
Managing Documents

Documents are stored as a list of named links. To add a document, provide a display name and a URL (e.g., a Google Drive or OneDrive share link). 
{
  "documents": [
    { "name": "Project Proposal", "url": "https://drive.google.com/..." },
    { "name": "Technical Specification", "url": "https://docs.google.com/..." }
  ]
}

​
Section Locks

Professors can lock three independent sections of a project to prevent the student owner from making edits during a review period.
Lock KeyWhat it protects
scopeScope Detail and Scope Notes fields
documentationDocuments list, Backup Link, and Grades Link
teamMember email list
When a section is locked, only an assigned professor or an administrator can edit it. The student owner will see the fields as read-only until the professor unlocks the section.
Professors toggle locks through PUT /api/projects/:id by updating the locks object: 
{
  "locks": {
    "scope": true,
    "documentation": false,
    "team": true
  }
}

​
Marking a Project as Favorite

The project owner can mark any of their projects as a favorite. Favorited projects appear in the Featured Projects carousel on the Dashboard, sorted by their number of pending tasks.
PATCH /api/projects/:id/favorite
{
  "isFavorite": true
}
Favorite your most active projects so their pending task counts are always visible at a glance on the Dashboard without navigating away.

​
Deleting Projects

Only the project owner can delete a project. Use the Delete option from the project’s action menu. To remove multiple projects at once, select them from the project list and use bulk delete.
DELETE /api/projects/bulk
{
  "ids": ["proj_abc123", "proj_def456"]
}
Deletion is permanent. All associated tasks, calendar events, and documents linked to a deleted project are removed and cannot be recovered.

Build docs developers (and LLMs) love

Get started for freeTalk to us