# Postbase

> Local-first PostgreSQL development platform with cloud provisioning

## Docs

- [Getting Started](/getting-started): Get up and running with Postbase in under 5 minutes.
- [Installation](/installation): Detailed installation instructions for different environments.
- [Quick Start](/quick-start): Build a complete application with Postbase in 10 minutes.
- [SDK Installation](/sdk/installation): Install and configure the Postbase SDK.
- [SDK Overview](/sdk/overview): Type-safe PostgreSQL client with Supabase-compatible query builder.
- [Query Builder](/sdk/query-builder): Advanced query patterns with the Postbase SDK.
- [Realtime Subscriptions](/sdk/realtime): Subscribe to database changes using PostgreSQL LISTEN/NOTIFY.
- [RPC Functions](/sdk/rpc): Call PostgreSQL functions with type safety.
- [Type Generation](/sdk/type-generation): Generate TypeScript types from your database schema.
- [Architecture](/reference/architecture): Technical architecture of the Postbase platform.
- [Contributing Guide](/reference/contributing): Thank you for your interest in contributing to Postbase! This guide covers everything you need to know to contribute effectively.
- [Roadmap](/reference/roadmap): Planned features and improvements for Postbase.
- [Troubleshooting](/reference/troubleshooting): Common issues and solutions.
- [Admin UI](/local/admin-ui): Web-based interface for database management.
- [Database Management](/local/databases): Create, list, and manage local PostgreSQL databases.
- [Migrations](/local/migrations): SQL-first migrations with checksum verification and rollback support.
- [Local Development Overview](/local/overview): Postbase provides a complete local PostgreSQL development environment that runs entirely on your machine.
- [SQL Editor](/local/sql-editor): Execute PostgreSQL queries with a modern code editor.
- [CI/CD Integration](/guides/ci-cd): Automate database operations in your CI/CD pipeline.
- [Migrating from Supabase](/guides/migrate-supabase): Migrate your Supabase project to Postbase.
- [Multi-Schema Setup](/guides/multi-schema): Organize your database with multiple schemas.
- [Deploying to Production](/guides/production): Best practices for deploying Postbase applications to production.
- [Environment Variables](/config/environment): Configure Postbase with environment variables.
- [postbase.toml](/config/postbase-toml): Project configuration file for Postbase.
- [Cloud Authentication](/cloud/authentication): Authenticate with Postbase Cloud using GitHub OAuth.
- [Configuration](/cloud/configuration): Configure cloud database infrastructure.
- [Cloud Platform Overview](/cloud/overview): Deploy PostgreSQL databases to the cloud with one command.
- [Projects](/cloud/projects): Organize databases into projects.
- [Database Provisioning](/cloud/provisioning): Create cloud PostgreSQL databases.
- [CLI Reference](/cli/overview): Complete reference for the Postbase command-line interface.
- [Automated Backups](/backups/automated): Daily automated backups for all cloud databases.
- [Manual Backups](/backups/manual): Create on-demand backups for additional data protection.
- [Backups & Recovery Overview](/backups/overview): Comprehensive data protection with automated backups and point-in-time recovery.
- [Point-in-Time Recovery (PITR)](/backups/pitr): Restore your database to any second within the retention window.
- [Restore Operations](/backups/restore): Restore databases from backups or point-in-time.
- [API Reference](/api/overview): RESTful API for Postbase Cloud platform.