@restatedev/restate 0.6.1 β 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +108 -0
- package/package.json +5 -5
package/README.md
ADDED
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
[](https://docs.restate.dev)
|
|
2
|
+
[](https://github.com/restatedev/examples)
|
|
3
|
+
[](https://discord.gg/skW3AZ6uGd)
|
|
4
|
+
[](https://twitter.com/intent/follow?screen_name=restatedev)
|
|
5
|
+
|
|
6
|
+
# Restate - Building resilient applications made easy!
|
|
7
|
+
|
|
8
|
+
<p align="center">
|
|
9
|
+
<picture>
|
|
10
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://restate.dev/poster_intro_dark.svg">
|
|
11
|
+
<source media="(prefers-color-scheme: light)" srcset="https://restate.dev/poster_intro_2.svg">
|
|
12
|
+
<img alt="Restate overview" src="https://restate.dev/poster_intro_2.svg" width="500">
|
|
13
|
+
</picture>
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
Easily build workflows, event-driven applications, and distributed services in a fault-tolerant manner with durable async/await.
|
|
17
|
+
|
|
18
|
+
[Restate](https://restate.dev) is great at building:
|
|
19
|
+
|
|
20
|
+
* [Lambda Workflows as Code](https://restate.dev/blog/we-replaced-400-lines-of-stepfunctions-asl-with-40-lines-of-typescript-by-making-lambdas-suspendable/)
|
|
21
|
+
* [Transactional RPC Handlers](https://github.com/restatedev/examples/tree/main/typescript/ecommerce-store)
|
|
22
|
+
* [Event Processing with Kafka](https://restate.dev/blog/restate--kafka-event-driven-apps-where-event-driven-is-an-implementation-detail/)
|
|
23
|
+
* [Much more](https://github.com/restatedev/examples)
|
|
24
|
+
|
|
25
|
+
## Get started with Restate
|
|
26
|
+
|
|
27
|
+
1. π [Check out our quickstart](https://docs.restate.dev/quickstart) to get up and running with Restate in 2 minutes!
|
|
28
|
+
1. π‘ [The tour of Restate](https://docs.restate.dev/tour) walks you through all features of Restate.
|
|
29
|
+
|
|
30
|
+
## SDKs
|
|
31
|
+
|
|
32
|
+
Restate supports the following SDKs:
|
|
33
|
+
|
|
34
|
+
* [Typescript](https://github.com/restatedev/sdk-typescript)
|
|
35
|
+
* [Java and Kotlin](https://github.com/restatedev/sdk-java)
|
|
36
|
+
|
|
37
|
+
## Install
|
|
38
|
+
|
|
39
|
+
We offer pre-built binaries of the CLI and the server for MacOS and Linux.
|
|
40
|
+
|
|
41
|
+
### Install the server
|
|
42
|
+
|
|
43
|
+
Install via Homebrew:
|
|
44
|
+
```bash
|
|
45
|
+
brew install restatedev/tap/restate-server
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Run via npx:
|
|
49
|
+
```bash
|
|
50
|
+
npx @restatedev/restate-server
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Run via docker:
|
|
54
|
+
```bash
|
|
55
|
+
docker run --rm -it --network=host docker.io/restatedev/restate:latest
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Install the CLI
|
|
59
|
+
|
|
60
|
+
Install via Homebrew:
|
|
61
|
+
```bash
|
|
62
|
+
brew install restatedev/tap/restate
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Install via npm:
|
|
66
|
+
```bash
|
|
67
|
+
npm install --global @restatedev/restate
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Run via npx:
|
|
71
|
+
```bash
|
|
72
|
+
npx @restatedev/restate
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
You can also download the binaries from the [release page](https://github.com/restatedev/restate/releases) or our [download page](https://restate.dev/get-restate/).
|
|
76
|
+
|
|
77
|
+
## Community
|
|
78
|
+
|
|
79
|
+
* π€οΈ [Join our online community](https://discord.gg/skW3AZ6uGd) for help, sharing feedback and talking to the community.
|
|
80
|
+
* π [Check out our documentation](https://docs.restate.dev) to get quickly started!
|
|
81
|
+
* π£ [Follow us on Twitter](https://twitter.com/restatedev) for staying up to date.
|
|
82
|
+
* π [Create a GitHub issue](https://github.com/restatedev/restate/issues) for requesting a new feature or reporting a problem.
|
|
83
|
+
* π [Visit our GitHub org](https://github.com/restatedev) for exploring other repositories.
|
|
84
|
+
|
|
85
|
+
## Core primitives
|
|
86
|
+
|
|
87
|
+
The basic primitives Restate offers to simplify application development are the following:
|
|
88
|
+
|
|
89
|
+
* **Reliable Execution**: user code will always run to completion. Intermediate failures result in re-tries that use the durable execution mechanism to recover partial progress and not duplicate already executed steps.
|
|
90
|
+
* **Suspending User Code**: long-running user code suspends when awaiting on a promise and resume when that promise is resolved.
|
|
91
|
+
* **Reliable Communication**: user code communicates with exactly-once semantics. Restate reliably delivers messages and anchors both sender and receiver in the durable execution to ensure no losses or duplicates can happen.
|
|
92
|
+
* **Durable Timers**: user code can sleep (and suspend) or schedule calls for later.
|
|
93
|
+
* **Isolation**: user code can be keyed, which makes Restate scheduled them to obey single-writer-per-key semantics.
|
|
94
|
+
* **Consistent State**: keyed user code can attach key/value state, which is eagerly pushed into handlers during invocation, and written back upon completion. This is particularly efficient for FaaS deployments (stateful serverless, yay!).
|
|
95
|
+
* **Observability & Introspection**: Restate automatically generates Open Telemetry traces for the interactions between handlers and gives you a SQL shell to query the distributed state of the application.
|
|
96
|
+
|
|
97
|
+
## Contributing
|
|
98
|
+
|
|
99
|
+
Weβre excited if you join the Restate community and start contributing!
|
|
100
|
+
Whether it is feature requests, bug reports, ideas & feedback or PRs, we appreciate any and all contributions.
|
|
101
|
+
We know that your time is precious and, therefore, deeply value any effort to contribute!
|
|
102
|
+
|
|
103
|
+
Check out our [development guidelines](/docs/dev/development-guidelines.md) and [tips for local development](/docs/dev/local-development.md) to get started.
|
|
104
|
+
|
|
105
|
+
### Building Restate locally
|
|
106
|
+
|
|
107
|
+
In order to build Restate locally [follow the build instructions](https://github.com/restatedev/restate/blob/main/docs/dev/local-development.md#building-restate).
|
|
108
|
+
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@restatedev/restate",
|
|
3
3
|
"description": "The Restate CLI",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.7.1",
|
|
5
5
|
"bin": "lib/index.js",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -29,9 +29,9 @@
|
|
|
29
29
|
"typescript": "^4.9.4"
|
|
30
30
|
},
|
|
31
31
|
"optionalDependencies": {
|
|
32
|
-
"@restatedev/restate-linux-x64": "0.
|
|
33
|
-
"@restatedev/restate-linux-arm64": "0.
|
|
34
|
-
"@restatedev/restate-darwin-x64": "0.
|
|
35
|
-
"@restatedev/restate-darwin-arm64": "0.
|
|
32
|
+
"@restatedev/restate-linux-x64": "0.7.1",
|
|
33
|
+
"@restatedev/restate-linux-arm64": "0.7.1",
|
|
34
|
+
"@restatedev/restate-darwin-x64": "0.7.1",
|
|
35
|
+
"@restatedev/restate-darwin-arm64": "0.7.1"
|
|
36
36
|
}
|
|
37
37
|
}
|