Skip to main content

Documentation Guide

Find what you need based on where you are in your Pikku journey.

Getting Started

New to Pikku? Start here:

  1. Introduction - Understand what Pikku is and why it exists
  2. Getting Started - Install and run your first Pikku app
  3. Functions - Learn the core abstraction

Learning Path

Fundamentals

Protocols

Advanced

Configuration & Deployment

I Want To...

Build an API

  1. Create functions
  2. Wire HTTP routes
  3. Add user sessions
  4. Generate OpenAPI spec

Add Real-Time Features

  1. Understand channels
  2. Wire WebSocket handlers
  3. Generate WebSocket client

Deploy to Production

  1. Choose a runtime (Express, Lambda, etc.)
  2. Configure tree-shaking (optional)
  3. Deploy to your chosen platform

Work in a Monorepo

  1. Configure package mappings
  2. Generate shared clients
  3. See monorepo example

Migrate from Another Framework / Integrate Pikku with Another Framework

  • From Express — Coming Soon
  • From Hono — Coming Soon

Still Need Help?