Orveth

Documentation

Orveth is a modular TypeScript backend framework ecosystem (pre-1.0). These guides document public entrypoints—start with @orveth/server or orveth, then add optional packages as needed.

Recommended path

  1. Introduction — what Orveth is and is not.
  2. Getting started — install and run a handler.
  3. Package index — choose modules for your service.
  4. Server — routing, middleware, and request context.
  5. Examples — compose packages in realistic setups.
IntroductionScope, non-goals, package map, and versioning expectations.Read introduction →Getting startedInstall with npm, pnpm, or Yarn and boot your first listener.Get started →InstallationScoped vs meta-package installs and optional integration modules.Install guide →Server runtimeRouting, middleware, context helpers, body limits, and errors.Server reference →ExamplesConfig, logging, TLS, JWT, and Prisma patterns you can copy.View examples →DeploymentRun services in production and host this documentation site.Deployment guide →

Package references

  • Core — lifecycle interfaces and package metadata.
  • HTTP — status constants and response preparation.
  • HTTPS / TLS — PEM loading and HTTPS listeners.
  • Errors — typed errors and JSON normalization.
  • Config — typed environment parsing.
  • Logger — structured logging contracts.
  • Validation — discriminated validation results.
  • JWT — HS256 sign/verify and bearer parsing.
  • Prisma — health routes and graceful shutdown.

Architecture

See Architecture for package layering, dependency rules, and the request lifecycle inside @orveth/server.