Skip to main content

Set up a local development environment for Temporal and TypeScript

Last updated on
Tags:

Temporal TypeScript SDK

To follow the TypeScript SDK tutorials and build your own Temporal applications, you'll need the TypeScript SDK and a Temporal server.

Install Node.js​

The TypeScript SDK requires Node.js 18 or later.

Install Node.js via your package manager by following the official Node.js instructions.

Set up the Temporal TypeScript SDK​

You can create a new project with the Temporal SDK:

npx @temporalio/create@latest ./my-app

You can also add the Temporal TypeScript SDK to an existing project with the following command:

npm install @temporalio/client @temporalio/worker @temporalio/workflow @temporalio/activity

Next, you'll configure a local Temporal Service for development.

Set up a local Temporal Service for development with Temporal CLI​

The fastest way to get a development version of the Temporal Service running on your local machine is to use Temporal CLI.

Temporal CLI is a tool for interacting with the Temporal Service from the command-line interface. It includes a self-contained distribution of the Temporal Service and Web UI as well which you can use for local development.

Install Temporal CLI on your local machine using the following instructions for your platform.

You can install the latest version with Homebrew using the following command:

brew install temporal

Once you've installed Temporal CLI and added it to your PATH, open a new Terminal window and run the following command:

temporal server start-dev

This command starts a local Temporal Service. It starts the Web UI, creates the default Namespace, and uses an in-memory database.

  • The Temporal Service will be available on localhost:7233.
  • The Temporal Web UI will be available at http://localhost:8233.

Leave the local Temporal Service running as you work through tutorials and other projects. You can stop the Temporal Service at any time by pressing CTRL+C.

Change the Web UI port

The Temporal Web UI may be on a different port in some examples or tutorials. To change the port for the Web UI, use the --ui-port option when starting the server:

temporal server start-dev --ui-port 8080

The Temporal Web UI will now be available at http://localhost:8080.

The temporal server start-dev command uses an in-memory database, so stopping the server will erase all your Workflows and all your Task Queues. If you want to retain those between runs, start the server and specify a database filename using the --db-filename option, like this:

temporal server start-dev --db-filename your_temporal.db

When you stop and restart the Temporal Service and specify the same filename again, your Workflows and other information will be available.

Once you have everything installed, you're ready to build apps with Temporal on your local machine.