Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/joaomonteir0/printheritage/llms.txt

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

PrintHeritage is a web-based monitoring platform built for heritage preservation teams. It provides a centralized workspace to ingest, organize, and visualize time-series data from structural sensors — such as Fiber Bragg Grating (FBG) displacement and temperature probes — installed in historic buildings.

Quickstart

Deploy PrintHeritage locally and make your first API call in minutes.

Deployment

Run the full platform with Docker Compose in a single command.

Core Concepts

Understand projects, roles, and datasets before you build.

API Reference

Explore every REST endpoint with request and response schemas.

​
What PrintHeritage Does

Heritage monitoring projects involve recurring field measurements taken from multiple sensors across one or more sites. PrintHeritage solves the coordination problem: multiple researchers and engineers collaborate on the same project, each with different levels of access, while the platform stores and renders the collected data as interactive charts. Key capabilities:
  • Multi-project workspaces — create separate projects per building or monitoring campaign
  • Role-based access control — four roles from SUPER_ADMIN down to VISUALIZER
  • Flexible data ingestion — upload CSV or XLSX files, or pull from an external HTTP endpoint
  • Interactive charts — line, area, bar, and scatter plots powered by ApexCharts
  • Sensor metadata — name sensors, assign units, and configure which chart types are valid
  • Audit trail — every user action is recorded and visible to administrators

​
Architecture Overview

PrintHeritage consists of two primary services orchestrated with Docker Compose:
ServiceTechnologyDefault Port
auth-serviceFastAPI (Python) + PostgreSQL8001
front-endReact + TypeScript3000
The auth service is the single backend API. It handles authentication, user management, project storage, and dataset records. The React front-end communicates with it over HTTP using JWT bearer tokens.
The repository also contains stub directories for ingestion-service, mqtt-handler, and query-service that are planned future services. They contain no code yet.

​
Getting Started

1

Clone the repository

git clone https://github.com/joaomonteir0/printheritage.git
cd printheritage
2

Start all services

docker compose up --build
3

Log in

Open http://localhost:3000 and sign in with the default super-admin account: super@print.com / password123.
4

Create your first project

Navigate to Create Project, give it a name and description, and start uploading sensor data.

Build docs developers (and LLMs) love

Get started for freeTalk to us