Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/TheSerchCp/SEAM/llms.txt

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

SEAM is a zero-framework, ES Modules SPA that gives teams a full administrative panel — users, roles, permissions, projects, tasks, grades, and reports — with real-time updates powered by Socket.IO. It runs directly in the browser against any compatible REST backend, with no build step required for the frontend.

Quickstart

Get SEAM running in minutes — start the dev server and connect your backend.

Architecture

Understand the layered structure: pages, services, repositories, and core utilities.

Core Concepts

Explore the Router, EventBus, ApiClient, and session state that power every page.

UI Components

Reusable Table, Form, Modal, Toast, and layout components ready to use.

What SEAM provides

SEAM ships a complete administrative SPA with eight functional modules and a shared component library:

Auth

JWT login with persistent session and Socket.IO reconnection.

Users

Full CRUD for system users with real-time table updates.

Roles & Permissions

Role management and granular permission assignment to roles.

Projects & Tasks

Project creation and per-project task administration.

Grades & Reports

Grade recording, consultation, and report generation.

Adding Pages

Step-by-step guide to extending SEAM with new modules.

Get started in three steps

1

Clone and install dependencies

Clone the repository and install the dev dependencies (Tailwind CSS, nodemon, PostCSS).
git clone https://github.com/TheSerchCp/SEAM.git
cd SEAM
npm install
2

Start your backend

SEAM expects a REST + Socket.IO backend at http://localhost:3001/api/v1. Start your backend server before launching SEAM.
3

Serve the frontend

Use the built-in Node.js HTTP server to serve the SPA:
npm start
Open http://localhost:3000 in your browser and log in.
Do not open index.html directly as a file:// URL — ES Modules require an HTTP server. Use npm start or VS Code’s Live Server extension.

Build docs developers (and LLMs) love