Teable: Deep Dive Tutorial

May 11, 2026 · View on GitHub

Project: Teable — A high-performance, multi-dimensional database platform built on PostgreSQL with real-time collaboration.

Why This Track Matters

Teable combines the power of PostgreSQL with a collaborative spreadsheet interface, offering teams a scalable no-code database that doesn't sacrifice data integrity or query performance for usability.

This track focuses on:

building on PostgreSQL with Teable's schema management and query system
implementing real-time collaborative editing with WebSocket consistency
generating and consuming REST and GraphQL APIs from Teable tables
deploying and scaling Teable with Docker for production workloads

What Is Teable?

Teable is a high-performance, multi-dimensional database platform that combines the power of PostgreSQL with a spreadsheet-like UI. It supports real-time collaboration, complex data relationships, and advanced querying — offering a scalable alternative to Airtable built on proven database technology.

Feature	Description
PostgreSQL Native	Built directly on PostgreSQL for performance and reliability
Multi-Dimensional	Grid, kanban, gallery, form, and calendar views
Real-Time Collab	WebSocket-based collaborative editing with conflict resolution
Advanced Queries	Complex filters, aggregations, cross-table relationships
REST & GraphQL	Auto-generated APIs with schema validation
Self-Hosted	Docker deployment with horizontal scaling

Mental Model

graph TB
    subgraph Frontend["Next.js Frontend"]
        GRID[Grid View]
        KANBAN[Kanban View]
        FORM[Form View]
        GALLERY[Gallery View]
    end

    subgraph Backend["NestJS Backend"]
        API[REST / GraphQL API]
        REALTIME[WebSocket Engine]
        QUERY[Query Builder]
        AUTH[Auth & RBAC]
    end

    subgraph Data["Data Layer"]
        PG[(PostgreSQL)]
        REDIS[(Redis Cache)]
        S3[Object Storage]
    end

    Frontend --> Backend
    Backend --> Data

Chapter Guide

Chapter	Topic	What You'll Learn
1. System Overview	Architecture	Teable's position in the database ecosystem
2. Database Architecture	Data Layer	PostgreSQL schema, storage engines, indexing
3. Setup Environment	Development	Complete development stack configuration
4. API Development	API Layer	REST/GraphQL contracts and validation patterns
5. Realtime Collaboration	Collaboration	WebSocket events and multi-user consistency
6. Query System	Querying	View-driven query planning and optimization
7. Frontend Architecture	UI Layer	Dynamic view rendering and state boundaries
8. Production Deployment	Operations	Deployment hardening, scaling, and observability

Tech Stack

Component	Technology
Backend	NestJS, TypeScript
Frontend	Next.js, React
Database	PostgreSQL
Cache	Redis
Real-Time	WebSockets
Deployment	Docker Compose

Ready to begin? Start with Chapter 1: System Overview.

Built with insights from the Teable repository and community documentation.

Full Chapter Map

Current Snapshot (auto-updated)

repository: teableio/teable
stars: about 21.2k
latest release: release.2026-05-06T00-14-49Z.1601 (published 2026-05-11)

What You Will Learn

how Teable uses PostgreSQL as its native storage layer with schema management and indexing
how WebSocket-based real-time collaboration handles multi-user consistency
how the query system translates view-driven filters into optimized PostgreSQL queries
how to deploy and scale Teable with Docker Compose for production environments

Source References

Teable

Generated by AI Codebase Knowledge Builder