This repository provides a comprehensive collection of sample projects demonstrating the capabilities of the Temporal TypeScript SDK. It serves as a learning resource for developers building resilient, scalable, and fault-tolerant applications with Temporal, showcasing various API patterns, design principles, and integration possibilities.

How It Works

The samples are organized by functionality, covering basic "hello world" examples, advanced API usage like signals, queries, and child workflows, and production-ready patterns such as worker versioning and debugging. Each sample is a self-contained Temporal project, allowing developers to quickly test specific features or architectural approaches. The repository emphasizes practical application, providing runnable code for common use cases.

Quick Start & Requirements

• Local Execution:
  • Install Temporal: brew install temporal or use alternative methods.
  • Start Temporal Server: temporal server start-dev
  • Install Node.js v18+ (v22.x recommended).
  • Clone the repo: git clone https://github.com/temporalio/samples-typescript.git
  • Navigate to a sample directory (e.g., cd samples-typescript/hello-world).
  • Install dependencies: npm install (or yarn, pnpm).
  • Run the sample: npm run start and npm run workflow in separate terminals.
• Browser Execution: Gitpod or GitHub Codespaces offer one-click execution.
• Scaffolding: Use npx @temporalio/create@latest my-project --sample sample-name to create new projects from samples.
• Development: pnpm install and pnpm run prepare for contributing.

Highlighted Details

• Extensive coverage of Activity and Workflow APIs, including timers, signals, queries, and async completion.
• Demonstrations of production patterns like worker versioning, patching, and debugging with VS Code.
• Examples of integrating with external systems and libraries, including LLMs, gRPC, and various frameworks (Next.js, NestJS, Express).
• Showcases advanced concepts like Interceptors for OpenTelemetry and custom payload conversion.
• Includes samples for monorepo setups using Turborepo and Nx.

Maintenance & Community

The project is actively maintained by the Temporal team. Community contributions are welcomed. Links to contributing guidelines and development setup are provided.

Licensing & Compatibility

The repository is licensed under the MIT License, permitting commercial use and integration with closed-source projects.

Limitations & Caveats

Some external projects linked may not be up-to-date. The repository structure of the food-delivery/ sample is relied upon by external blog posts and documentation. Configuration files in .shared/ overwrite sample-specific configurations.