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.

Classify is a full-stack school management platform built for technical education institutions. It connects students working on group projects, professors tracking attendance and managing courses, and administrators overseeing the entire academic operation — all from a single web application backed by biometric hardware integration.

Quickstart

Set up Classify locally and start the dev server in minutes

Architecture

Understand the monorepo structure, tech stack, and data flow

API Reference

Full REST API documentation with request and response schemas

Self-Hosting

Deploy Classify with your own Supabase project and hardware

​
What Classify Does

Classify combines project management, attendance tracking, and academic administration into a single platform tailored for schools running multi-year technical programs.

Projects & Tasks

Group projects with Kanban task boards, member management, and document storage

Attendance

Biometric attendance via ESP32 fingerprint sensors, with professor override controls

Academic Calendar

Per-project events and deadlines visible across the whole team

Role-Based Access

Separate dashboards and permissions for students, professors, and admins

Admin Panel

Manage users, courses, subjects, schedules, and hardware devices

Professor Tools

Attendance sessions, course rosters, and project assignment for professors

​
Get Running in 3 Steps

1

Clone and install dependencies

Clone the repository and install all workspace packages with pnpm.
git clone https://github.com/Taykl12/Classify.git
cd Classify
pnpm install
2

Configure environment variables

Copy the server environment file and add your Supabase credentials.
cp server/.env.example server/.env
# Edit server/.env and set SUPABASE_ANON_KEY and SUPABASE_URL
3

Start the development servers

Run the API server and the Vite frontend in separate terminals.
# Terminal 1
pnpm run dev:server   # Express API on :3001

# Terminal 2
pnpm run dev          # Vite frontend on :5173
Open http://localhost:5173 to see Classify running locally.
The Vite dev server proxies all /api/* requests to Express on port 3001. Both servers must be running at the same time during development.

Build docs developers (and LLMs) love

Get started for freeTalk to us