How-to Guides

Welcome to the Platformatic guides! These practical guides help you solve specific problems and implement features in your Platformatic applications.

Application Development

Building Applications

• Build a Modular Monolith - Create a comprehensive library application with multiple Platformatic DB and Gateway services, learn API composition and client generation
• Generate Frontend Code for REST APIs - Auto-generate TypeScript clients for your Platformatic REST APIs
• Using Watt with Node Config - Integrate Node.js configuration management with Watt applications
• Use Watt with AI Coding Agents - Let an AI coding agent set up, configure, and deploy Watt using the official Agent Skill

Caching & Performance

• Cache with Platformatic Watt - Implement caching strategies to improve application performance
• Profiling with Watt - Profile and optimize your Watt applications for better performance
• Capture Flamegraphs on Health Events - Automatically capture CPU profiles when workers become unhealthy and upload them to S3
• Debugging with REPL - Debug applications interactively using the built-in REPL

Multi-Repository & Scaling

• Use Watt with Multiple Repositories - Manage Watt applications across multiple repositories
• Watt Architecture Patterns - Choose between pyramid and funnel architectures for Watt applications
• Scheduler - Implement scheduled tasks and background jobs in your applications

Framework Integration

• Capabilities - Understand and use Platformatic's framework integration capabilities
• Frameworks - Integrate with popular frontend and backend frameworks
• Run Next.js Image Optimizer as a Dedicated Service - Set up a standalone /_next/image service with local fallback resolution

Deployment & Operations

Deployment

• Dockerize a Watt App - Create Docker containers for your Watt applications
• Kubernetes Readiness & Liveness - Configure health checks for Kubernetes deployments
• TypeScript Deployment - Deploy TypeScript-based Platformatic applications
• Deploy Next.js in Kubernetes with Watt - Deploy Next.js in Kubernetes with Watt

Monitoring & Observability

Logging

• Logging Configuration - Configure comprehensive logging for different environments and use cases
• Logging to Elasticsearch - Set up centralized logging with Elasticsearch and Kibana

Metrics & Monitoring

• Metrics with Prometheus & Grafana - Set up monitoring dashboards with Prometheus and Grafana
• Distributed Tracing - Implement distributed tracing across your microservices

Management & Tools

• CLI Management - Master the Platformatic CLI tools for efficient development workflows

Getting Help

If you can't find what you're looking for in these guides:

1. Check the Reference Documentation for detailed API specifications
2. Try the Getting Started tutorials for step-by-step learning
3. Visit our GitHub repository for community support

Contributing

Found an issue with a guide or want to contribute a new one? Check out our Contributing Guide to learn how to help improve the documentation.