Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/restatedev/examples
Restate examples
https://github.com/restatedev/examples
Last synced: 6 days ago
JSON representation
Restate examples
- Host: GitHub
- URL: https://github.com/restatedev/examples
- Owner: restatedev
- License: mit
- Created: 2023-08-10T08:00:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-01T13:18:30.000Z (14 days ago)
- Last Synced: 2024-11-01T14:22:56.849Z (14 days ago)
- Language: TypeScript
- Homepage: https://restate.dev
- Size: 5.42 MB
- Stars: 43
- Watchers: 7
- Forks: 9
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-durable-executions - Restate examples
- awesome-durable-executions - Restate examples
README
[](https://docs.restate.dev)
[](https://discord.gg/skW3AZ6uGd)
[](https://twitter.com/intent/follow?screen_name=restatedev)
# Restate examples
A collection of examples that illustrate how to use Restate to solve common application
challenges.
* **[Use Cases and Patterns](patterns-use-cases):** Small specific use cases, like webhooks,
workflows, asynchronous task queuing.
* **[Basics](basics):** Small examples highlighting the basic building blocks, like
durable execution or virtual objects.
* **[End-to-End Applications](end-to-end-applications):** Runnable demo applications that consist
of many components, e.g., a food ordering app, or an e-commerce site.
Typically packaged as a docker compose setup.
* **[Tutorials](tutorials):** A step-by-step guide that builds an application and introduces
the Restate concepts on the way.
* **[Templates](templates):** Project templates for various languages and build systems.
Simple 'Hello World!' examples in a proper build setup that you can use if you want to start
a brand new project for a service or lambda that will be invoked through Restate.
## Examples by Language
### TypeScript
| Type | Name / Link |
|------------|----------------------------------------------------------------------------------------------------|
| Basics | [Workflows, Durable Execution, Event-processing, Virtual Objects](basics/basics-typescript) |
| Use Cases | [Sagas](patterns-use-cases/sagas/sagas-typescript) |
| Use Cases | [Durable Promises](patterns-use-cases/durable-promises/durable-promises-typescript) |
| Use Cases | [State Machines](patterns-use-cases/state-machines/state-machines-typescript/) |
| Use Cases | [Payment Service](patterns-use-cases/payment-state-machine/payment-state-machine-typescript/) |
| Use Cases | [Async Tasks - Payments](patterns-use-cases/async-signals-payment/async-signals-payment-typescript/) |
| End-to-End | [Food Ordering App](end-to-end-applications/typescript/food-ordering) |
| End-to-End | [AI Image Processing Workflow](end-to-end-applications/typescript/ai-image-workflows) |
| End-to-End | [LLM-powered Chat Bot / Task Agent](end-to-end-applications/typescript/chat-bot) |
| Tutorial | [Tour of Restate](tutorials/tour-of-restate-typescript) |
| Templates | [Restate Node/TS Template](templates/typescript) |
| Templates | [Restate Bun/TS Template](templates/bun) |
| Templates | [Restate CloudFlare Workers/TS Template](templates/cloudflare-workers) |
| Templates | [Restate Deno/TS Template](templates/deno) |
| Templates | [Testing Restate app with Test Containers](templates/typescript-testing) |
### Java
| Type | Name / Link |
|------------|------------------------------------------------------------------------------------------------|
| Templates | [Maven Template](templates/java-maven) |
| Templates | [Maven - Spring Boot Template](templates/java-maven-spring-boot) |
| Templates | [Maven - Quarkus Template](templates/java-maven-quarkus) |
| Templates | [Gradle Template](templates/java-gradle) |
| Basics | [Durable Execution, Event-processing, Virtual Objects](basics/basics-java) |
| Use Cases | [Sagas](patterns-use-cases/sagas/sagas-java) |
| Use Cases | [Payment Service](patterns-use-cases/payment-state-machine/payment-state-machine-java/) |
| Use Cases | [Async Tasks - Payments](patterns-use-cases/async-signals-payment/async-signals-payment-java/) |
| Patterns | [Spring & Spring JPA](patterns-use-cases/integrations/java-spring) |
| End-to-End | [Food Ordering App](end-to-end-applications/java/food-ordering) |
| Tutorial | [Tour of Restate](tutorials/tour-of-restate-java/) |
### Kotlin
| Type | Name / Link |
|------------|-------------------------------------------------------------------------------------------------|
| Templates | [Template using Gradle](templates/kotlin-gradle) |
| Basics | [Durable Execution, Event-processing, Virtual Objects](basics/basics-kotlin) |
| Use Cases | [Sagas](patterns-use-cases/sagas/sagas-kotlin) |
| End-to-End | [Food Ordering App](end-to-end-applications/kotlin/food-ordering) |
| End-to-End | [Todos Kotlin Multiplatform + Android app](end-to-end-applications/kotlin/kmp-android-todo-app) |
### Python
| Type | Name / Link |
|-----------|-----------------------------------------------------|
| Templates | [Python Template](templates/python) |
| Tutorial | [Tour of Restate](tutorials/tour-of-restate-python) |
### Go
| Type | Name / Link |
|-----------|-------------------------------------------------|
| Templates | [Go Template](templates/go) |
| Tutorial | [Tour of Restate](tutorials/tour-of-restate-go) |
| Tutorial | [Restate + Knative](tutorials/knative-go) |
### Rust
| Type | Name / Link |
|-----------|------------------------------------------------------|
| Templates | [Rust Template](templates/rust) |
| Templates | [Rust - Shuttle.rs Template](templates/rust-shuttle) |
## Joining the community
If you want to join the Restate community in order to stay up to date, then please join our [Discord](https://discord.gg/skW3AZ6uGd).
The Discord server is also the perfect place for sharing your feedback with us, learning more about Restate and connect with others!
## Running the examples
Some examples are just illustrations of code, but many are runnable. Their READMEs generally explain
how to get them running. Here are the general steps:
### (1) Starting the Restate Server
Examples that run individually typically need a running Restate Server instance.
Some examples can be run with Docker Compose. Those already bring their own Restate server instance.
You can launch Restate in a number of ways, including using the [Restate Cloud](https://restate.dev/get-restate-cloud/)
service. See [Get Restate](https://restate.dev/get-restate/) for all options to run Restate. Here is a short-list
of options to run Restate Server locally.
Install and run the `restate-server` binary:
- Download from https://github.com/restatedev/restate/releases
- Install with Homebrew: `brew install restatedev/tap/restate-server`
- Install with _npm_: `npm install --global @restatedev/restate-server@latest`
- Run in Docker: `docker run --name restate_dev --rm -p 8080:8080 -p 9070:9070 -p 9071:9071 --add-host=host.docker.internal:host-gateway docker.io/restatedev/restate:latest`
### (2) Register the examples at Restate Server
The service endpoints need to be registered in Restate, so that Restate will proxy their function calls and
do its magic. Once both server and example are running, register the example:
* Via the [CLI](https://docs.restate.dev/operate/cli): `restate deployments register localhost:9080`
* Via `curl localhost:9070/deployments -H 'content-type: application/json' -d '{"uri": "http://localhost:9080"}'`
**Important** When running Restate with Docker, use `host.docker.internal` instead of `localhost` in the URIs above.
----
----
## Adding Examples and Releasing (for Restate developers/contributors)
When adding a new example:
* Make sure it has a README
* Add it to this README
* Check it's listed in run tests/update examples scripts in [`.tools`](./.tools)
* Optionally, add it to the [zips script](./.tools/prepare_release_zip.sh) and [`release.yaml`](./.github/workflows/release.yml)
**Creating a Release**
Before releasing, trigger the "pre-release" workflow to update sdk versions. This automatically creates a pull request, which must be manually merged.
Once the repo is ready for the release, push a tag of the form `vX.Y.Z`:
```shell
git checkout main
git tag -m "Examples v0.9.1" v0.9.1
git push origin v0.9.1
```
This triggers a workflow that [creates a draft release](https://github.com/restatedev/examples/releases) on GitHub, which you need to approve to finalize it.
Please update the version tag referenced on the [Tour of Restate](https://github.com/restatedev/documentation/blob/main/docs/tour.mdx) documentation page.