temporal README

The project's README from github.com/temporalio/temporal. As one markdown file: README.md.

Temporal—durable execution platform

GitHub Release GitHub License Code Coverage Community Go Report Card

Introduction   •   Getting Started   •   Contributing   •   Temporal Docs   •   Temporal 101

Introduction

Temporal is a durable execution platform that enables developers to build scalable applications without sacrificing productivity or reliability. The Temporal server executes units of application logic called Workflows in a resilient manner that automatically handles intermittent failures, and retries failed operations.

Temporal is a mature technology that originated as a fork of Uber's Cadence. It is developed by Temporal Technologies, a startup by the creators of Cadence.

image

Getting Started

Download and Start Temporal Server Locally

Execute the following commands to start a pre-built image along with all the dependencies.

brew install temporal
temporal server start-dev

Refer to Temporal CLI documentation for more installation options.

Run the Samples

Clone or download samples for Go or Java and run them with the local Temporal server. We have a number of HelloWorld type scenarios available, as well as more advanced ones. Note that the sets of samples are currently different between Go and Java.

Use CLI

Use Temporal CLI to interact with the running Temporal server.

temporal operator namespace list
temporal workflow list

Use Temporal Web UI

Try Temporal Web UI by opening http://localhost:8233 for viewing your sample workflows executing on Temporal.

Repository

This repository contains the source code of the Temporal server. To implement Workflows, Activities and Workers, use one of the supported languages.

Contributing

We'd love your help in making Temporal great.

Helpful links to get started:

License

MIT License

temporal (temporalio/temporal)

Searching Database…

23.8K ·GitHub
What is this?Temporal is a durable execution platform: a server that runs units of application logic called Workflows resiliently, automatically handling intermittent failures and retrying failed operations.
Is this repo the whole product, or just one piece of it?Just one piece: this repository contains only the Temporal server itself. Your Workflows, Activities and Workers are implemented in your own application using an SDK in a supported language, not in this codebase.
How do I get a server running locally to try it?Start a pre-built server image locally with all dependencies included; the Temporal CLI docs cover more installation options. Then clone or download the Go or Java samples and run them against the local server.
Which languages do I write workflow code in?The server itself is written in Go, but your workflow code uses an SDK in a supported language. The README points to Go and Java samples and notes the two sample sets are currently different.
What happens if a step fails while a workflow is running?That is the core promise rather than a gap: the server executes Workflows resiliently, handles intermittent failures automatically and retries failed operations on its own.
Where does this server run — on my own machine, or do I need special infrastructure?It is a self-hosted server: the quick start runs a pre-built image with all dependencies on your local machine, and you can also build and run the server yourself from this source code.
Is this a new experiment or proven technology?Proven: Temporal is a mature platform that originated as a fork of Uber's Cadence and is developed by Temporal Technologies, a startup founded by the creators of Cadence.
What do the starter samples cover?HelloWorld-type scenarios plus more advanced ones. Go and Java each have their own sample set, and the two sets are currently different from each other.
Can I watch my workflows while they execute?Yes — the Temporal Web UI lets you open and view your sample workflows executing on the server.
Is there a command-line way to operate a running server?Yes — Temporal CLI is the companion tool for interacting with the running Temporal server, and its documentation also lists more installation options.
Creator
temporalio
Size
165.6 MB
Stars
23.8K
Age
7y
Commits · 90 Days