Skip to main content

Getting started

You can run "Hello Temporal" locally in under 5 minutes, assuming you have all prerequisites set up.

Step 0: Prerequisites#

This project requires nodejs LTS version 14 (or later).

Furthermore, you will need to install node-gyp.

If you run into errors during installation it is likely your environment is not properly set up.

The Worker package embeds the Temporal Core SDK which requires the Rust toolchain to compile.

We've provided prebuilt binaries for the Worker for:

  • Mac with an Intel chip: x86_64-apple-darwin
  • Mac with an Apple chip: aarch64-apple-darwin
  • Linux with x86_64 architecture: x86_64-unknown-linux-gnu
  • Windows with x86_64 architecture: x86_64-pc-windows-gnu (Windows is not yet supported but it is a priority for us).

If you need to compile the Worker yourself, set up the Rust toolchain by following the instructions here.

note

Brew installation of NodeJS>=15 does not work with the SDK, install Node with nvm instead.

note

Make sure you also have Temporal Server running. If you haven't set it up yet, we recommend following the Temporal Server Quick Install via docker-compose:

Step 1: Create a new project#

Use the package initializer to create a new project.

npx @temporalio/create@latest ./example
cd example

This will set up with the basic Hello World sample. If you want a sample for connecting to a Temporal Server instance secured with mTLS, you can use npx @temporalio/create@latest ./example --sample hello-world-mtls.

note

init triggers native module compilation which might take a while, npm 7 hides the compilation output so it may appear that the installation is stuck, to see the compilation progress export NPM_CONFIG_FOREGROUND_SCRIPTS=true.

Step 2: Compile Typescript#

Use one of the provided helper package scripts to compile Typescript.

# Watch files and compile on change (recommended because it's most convenient)
npm run build.watch
## OR
## Compile Typescript once (you will need to rerun this every time you edit the code)
# npm run build
note

ts-node does not work with our project structure since it changes __dirname which affects the automatic Workflow and Activity registration and we don't support running typescript directly in the Workflow v8 isolates.

Step 3: Run your Workflow#

Run the Worker:

$ npm start # this runs node lib/worker
# example successful output:
2021-05-19T17:27:33.176Z [INFO] asset main.js 4.78 MiB [emitted] (name: main)
2021-05-19T17:27:33.178Z [INFO] runtime modules 891 bytes 4 modules
2021-05-19T17:27:33.178Z [INFO] modules by path ./node_modules/ 4.66 MiB
2021-05-19T17:27:33.178Z [INFO] modules by path ./node_modules/@temporalio/ 4.54 MiB 14 modules
2021-05-19T17:27:33.178Z [INFO] modules by path ./node_modules/protobufjs/ 51.2 KiB
2021-05-19T17:27:33.178Z [INFO] modules by path ./node_modules/protobufjs/src/*.js 28.8 KiB 7 modules
2021-05-19T17:27:33.178Z [INFO] modules by path ./node_modules/protobufjs/src/util/*.js 17.7 KiB 2 modules
2021-05-19T17:27:33.178Z [INFO] 2 modules
2021-05-19T17:27:33.178Z [INFO] modules by path ./node_modules/@protobufjs/ 23.7 KiB 7 modules
2021-05-19T17:27:33.178Z [INFO] ./node_modules/long/src/long.js 39.2 KiB [built] [code generated]
2021-05-19T17:27:33.178Z [INFO] ./node_modules/ms/index.js 2.95 KiB [built] [code generated]
2021-05-19T17:27:33.178Z [INFO] modules by path ../../../../../src/ 686 bytes
2021-05-19T17:27:33.178Z [INFO] ../../../../../src/main.js 362 bytes [built] [code generated]
2021-05-19T17:27:33.178Z [INFO] ../../../../../src/@activities/greeter.js 324 bytes [built] [code generated]
2021-05-19T17:27:33.178Z [INFO] ./lib/workflows/example.js 398 bytes [built] [code generated]
2021-05-19T17:27:33.178Z [INFO] webpack 5.37.1 compiled successfully in 1058 ms
2021-05-19T17:27:33.408Z [INFO] Worker state changed { state: 'RUNNING' }

Then start your Workflow:

$ node lib/worker/schedule-workflow.js
Hello, Temporal!

This "Hello Temporal" message comes from the combination of:

You can verify this via the Input and Result fields in Temporal Web (available at localhost:8088 on the default docker-compose):

image

Next Steps#

For a full code walkthrough of the Hello World example that you have spun up here, see our Hello World documentation.

Get notified of updates