Putnami
DocsGitHub

Licensed under FSL-1.1-MIT

Getting Started
Concepts
How To
Build A Web App
Build An Api Service
Share Code Between Projects
Configure Your App
Add Persistence
Add Authentication
Add Background Jobs
Principles
Tooling & Workspace
Workspace Overview
Cli
Jobs & Commands
SDK
Error Handling
Extensions
Typescript
Go
Python
Docker
Ci
Frameworks
Typescript
OverviewWebReact RoutingForms And ActionsStatic FilesApiErrors And ResponsesConfigurationLoggingHttp And MiddlewareDependency InjectionPlugins And LifecycleSessionsAuthPersistenceEventsStorageCachingWebsocketsTestingHealth ChecksTelemetryProto GrpcSmart Client
Go
OverviewHttpDependency InjectionPlugins And LifecycleConfigurationSecurityPersistenceErrorsEventsStorageCachingLoggingTelemetryGrpcService ClientsValidationOpenapiTesting
Platform
  1. DocsSeparator
  2. How To

How-To

How-To answers one question: Can you build real things with Putnami, easily?

Each guide is:

  • outcome-driven
  • reassuring
  • cross-layer
  • minimal but complete

Each guide should feel like: "Oh. That's it?"

What This Is Not

  • not a framework manual
  • not a CLI reference
  • not exhaustive
  • not language theory

If a guide tries to teach everything, it failed.

By Intent

How-To is organized by user intent, not architecture.

Build

  • Build a web app
  • Build an API service
  • Share code between projects
  • Configure your app

Extend

  • Add persistence
  • Add authentication
  • Add background jobs

Learn by Running Code

If you prefer learning by running code, the samples/ folder contains a progressive learning path — 13 projects that build on each other from a minimal HTTP server to a full-stack app. Each sample is self-contained and runnable.

How-To guide Companion sample
Build a web app 03-react-app
Build an API service 02-rest-api
Share code between projects 05-dependency-injection
Configure your app 04-configuration
Add persistence 06-database
Add authentication 07-authentication
Create an extension shell-extension

The samples also cover features not yet in the how-to guides: real-time, events, service-to-service clients, storage, caching, and a capstone fullstack app that combines everything.

Structure Rule

Every guide must say:

  • what you'll build (first paragraph)
  • what you'll end with (last paragraph)

And it must end with:

You now have X.

On this page

  • How-To
  • What This Is Not
  • By Intent
  • Build
  • Extend
  • Learn by Running Code
  • Structure Rule