Skip to content

Examples

Examples show the next step after project generation: what to keep, what to rewrite, and how PolePosition's structure supports a real workflow.

Available Examples

User Registration

Shows how to turn a generated module into a real user registration REST API with command flow, file-by-file edits, password hashing, tests, and migration checks.

Focus:

  • polepos start account-api
  • polepos add module users
  • POST /api/v1/users/register
  • module-local model, schema, repository, service, router, and test changes
  • Alembic migration review

Read the site guide: User Registration

Auth Foundation

Shows how the generated JWT authentication foundation protects routes before a full login system exists.

Focus:

  • public versus protected endpoints
  • JWT-based current user resolution
  • role-gated route examples
  • local token generation for testing

Read the site guide: Auth Foundation

Source scenario: examples/auth-foundation

HTML Swap

Shows how a generated module can be reshaped into a focused transformation endpoint backed by PostgreSQL history.

Focus:

  • polepos add module html --api-only
  • rewriting a generated module for a real endpoint contract
  • PostgreSQL-backed swap history
  • POST /api/v1/html/swap

Read the site guide: HTML Swap

Source scenario: examples/html-swap