Quickstart

This guide takes you through your first steps with Restate.

Prerequisites

• Build tools for your programming language:
  • TypeScript: Latest stable version of NodeJS >= v18.17.1 and npm CLI >= 9.6.7
  • Java/Kotlin: JDK >= 11
• Optional but recommended: Install the Restate CLI

TypeScript

1

Get the project template

Use the Node template to get started. This template includes a skeleton of a TypeScript Restate service:

npx -y @restatedev/create-app@latest && cd restate-node-template

Get all the dependencies and build tools:

npm install

2

Build and run the service

Now, you are all set to start developing your service in src/app.ts. You can run the app with ts-node-dev while developing:

npm run app-dev

Once you have implemented your service, build the app and run it:

npm run build

npm run app

This starts the greeter service on port 9080.

3

Launch Restate

npx

Homebrew

Docker

npx @restatedev/restate-server

💡Single binary

Restate is a single self-contained binary. No external dependencies needed. Check out our download page for other ways to run Restate.

4

Register the service

Now, we need to tell Restate where the service is running. You can use the Restate CLI via npx or via a global npm install. Alternatively, you can use curl:

CLI

curl

restate dp add http://localhost:9080

If you run Restate with Docker, you need to use http://host.docker.internal:9080 instead of http://localhost:9080 to reach the service deployment.

Restate then sends a request to the service deployment to ask which services and handlers are running behind this endpoint and will remember these. After executing this curl request, you should see the registered services and handlers printed to your terminal.

5

Send requests to the service

Invoke the function via:

curl localhost:8080/Greeter/greet -H 'content-type: application/json' \

-d '"Hi"'

You should now see printed as response: Hi!

Java

1

Get the project template

Download Java Hello world example:

CLI

wget

restate example java-hello-world-gradle &&

cd java-hello-world-gradle

2

Build and run the service

You are all set to start developing your service.

./gradlew build

Open the project in an IDE and configure it to build with Gradle. Run your service via:

./gradlew run

3

Launch Restate

npx

Homebrew

Docker

npx @restatedev/restate-server

💡Single binary

Restate is a single self-contained binary. No external dependencies needed. Check out our download page for other ways to run Restate.

4

Register the service

Now, we need to tell Restate where the service is running. You can use the Restate CLI via npx or via a global npm install. Alternatively, you can use curl:

CLI

curl

restate dp add http://localhost:9080

If you run Restate with Docker, you need to use http://host.docker.internal:9080 instead of http://localhost:9080 to reach the service deployment.

Restate then sends a request to the service deployment to ask which services and handlers are running behind this endpoint and will remember these. After executing this curl request, you should see the registered services and handlers printed to your terminal.

5

Send requests to the service

Invoke the function via:

curl localhost:8080/Greeter/greet -H 'content-type: application/json' -d '"Hi!"'

You should now see printed as response: Hi!

Kotlin

1

Get the project template

Download Kotlin Hello world example:

CLI

wget

restate example kotlin-hello-world-gradle &&

cd kotlin-hello-world-gradle

2

Build and run the service

You are all set to start developing your service.

./gradlew build

Open the project in an IDE and configure it to build with Gradle. Run your service via:

./gradlew run

3

Launch Restate

npx

Homebrew

Docker

npx @restatedev/restate-server

💡Single binary

Restate is a single self-contained binary. No external dependencies needed. Check out our download page for other ways to run Restate.

4

Register the service

Now, we need to tell Restate where the service is running. You can use the Restate CLI via npx or via a global npm install. Alternatively, you can use curl:

CLI

curl

restate dp add http://localhost:9080

If run Restate with Docker, you need to use http://host.docker.internal:9080 instead of http://localhost:9080 to reach the service deployment.

Restate then sends a request to the service deployment to ask which services and handlers are running behind this endpoint and will remember these. After executing this curl request, you should see the registered services and handlers printed to your terminal.

5

Send requests to the service

Invoke the function via:

curl localhost:8080/Greeter/greet -H 'content-type: application/json' -d '"Hi"'

You should now see printed as response: Hi!

Congratulations, you managed to run your first Restate service!

Next steps

Possible next steps:

• Discover the key features of Restate in the Tour of Restate
• Run the examples