Skip to content

Guides

Comprehensive guides for implementing Flowfull features in your backend.

Getting Started

Core Features

HybridCache Guide

Learn how to implement the 3-tier caching system for lightning-fast performance.

  • 📖 HybridCache Guide - Complete caching guide
  • Performance: 97% cache hit rate, 50x faster
  • 🎯 Use Cases: User profiles, sessions, API responses

Trust Tokens Guide

Implement secure, single-use tokens for email verification, password reset, and invitations.

  • 📖 Trust Tokens Guide - Complete PASETO guide
  • 🔐 Security: 6 validation layers, Ed25519 signatures
  • 🎯 Use Cases: Email verification, password reset, invitations

Protected Routes Guide

Learn how to protect your API routes with authentication middleware.

  • 📖 Protected Routes Guide - Route protection patterns
  • 🛡️ Security: Multiple validation modes
  • 🎯 Use Cases: User authentication, role-based access, permissions

Infrastructure

Database Setup Guide

Set up and configure databases for your Flowfull backend.

  • 📖 Database Setup Guide - Complete database guide
  • 🗄️ Databases: PostgreSQL, MySQL, LibSQL, Neon, PlanetScale
  • 🎯 Use Cases: Production setup, migrations, connection pooling

Deployment Guide

Deploy your Flowfull backend to production.

  • 📖 Deployment Guide - Complete deployment guide
  • 🚀 Platforms: Vercel, Railway, Fly.io, AWS, Google Cloud
  • 🎯 Use Cases: Production deployment, scaling, monitoring

By Use Case

Building an API?

  1. Getting Started
  2. Protected Routes
  3. HybridCache

Need Authentication?

  1. Bridge Validation
  2. Validation Modes
  3. Auth Middleware

Optimizing Performance?

  1. HybridCache Guide
  2. Database Setup
  3. Deployment

Implementing Security?

  1. Trust Tokens
  2. Validation Modes
  3. Protected Routes

By Technology

Official Starter Kit

flowfull-node (Node.js/TypeScript) ✅

  • Official starter kit maintained by Pubflow team
  • All guides include TypeScript examples
  • Bun runtime recommended
  • Hono framework for APIs
  • Production-ready with all core features

Community Starter Kits (Coming Soon)

flowfull-go 🚧

  • Community starter kit in development
  • Bridge validation examples available
  • Database: sqlc or GORM
  • Framework: Gin or Echo

flowfull-python 🚧

  • Community starter kit in development
  • FastAPI integration examples
  • Database: SQLAlchemy or Tortoise ORM
  • Framework: FastAPI

flowfull-rust 🚧

  • Community starter kit in development
  • Actix-web integration examples
  • Database: Diesel or SeaORM
  • Framework: Actix-web or Axum

Want to Contribute?

Create a starter kit for your favorite language! See the Community Contributions section in the Getting Started guide.

Need Help?

If you need assistance, professional support, or want us to build your backend:

  • 🌐 Notside.com - Technology firm specializing in Pubflow
  • 📧 Email: contact@notside.com
  • 💼 Services: Custom development, consulting, enterprise support

Contributing

Want to contribute a guide?

  1. Fork the repository
  2. Create your guide in docs/guides/
  3. Follow the existing format
  4. Submit a pull request

We welcome contributions for:

  • Language-specific guides (Go, Python, Rust)
  • Framework integrations (Express, Fastify, NestJS)
  • Deployment platforms (AWS, GCP, Azure)
  • Advanced patterns and best practices

Released under the MIT License.