postchi Internal Documentation
Welcome to the internal documentation for Postchi - an email delivery platform built as an alternative to SendGrid and Mailgun.
About This Documentation
This documentation site contains internal technical documentation, architecture notes, implementation plans, and infrastructure guides for the Postchi project. It's designed for the development team and contributors.
What is Postchi?
Postchi is a complete email delivery platform designed as an alternative to SendGrid and Mailgun. Built with modern technologies (Node.js, TypeScript, PostgreSQL), Postchi provides everything needed to send, track, and manage transactional and marketing emails at scale.
Key Features
- All-in-One Platform - Email delivery, automation, contacts, and analytics
- Modern Architecture - Built with TypeScript, React, and battle-tested technologies
- Complete Control - Full control over your email infrastructure
- Privacy Focused - Keep your data secure and maintain full privacy
Documentation Structure
📖 Core Documentation
- Product Overview - Comprehensive overview of features and capabilities
- API Reference - Complete API documentation with examples
🏗️ Infrastructure
- Postfix Setup Guide - Email server configuration
- DNS Setup for Postchi.io - DNS configuration
- Dedicated IP Strategy - IP management and warmup
- Scale & Compliance - Scaling strategies and compliance requirements
- System Emails Architecture - System email design
📚 Guides
- Email Deliverability Testing - Best practices for deliverability
- Template Helpers - Template helper functions reference
🛠️ Development
- Template Builder Implementation Plan - Template builder roadmap
- TODO - Project tasks and roadmap
Quick Links
- GitHub Repository: StudioAccolade/postchi
- Dashboard: http://localhost:5173
- API: http://localhost:3000
Technology Stack
Backend
- Node.js 20+ with TypeScript
- Express.js
- PostgreSQL 15+ with Prisma ORM
- Redis 7+ with BullMQ
- Postfix + OpenDKIM
Frontend
- React 18+ with TypeScript
- Vite
- shadcn/ui (Radix UI + Tailwind CSS)
- TanStack Query
- React Router v6
Getting Started
If you're new to the project, start with:
- Product Overview - Understand what Postchi is and what it does
- API Reference - Learn about the API endpoints
- Infrastructure Guides - Set up the email infrastructure
Contributing
This is internal documentation. For contribution guidelines, see the main repository README.
Last Updated: February 2025 Maintained by: Studio Accolade