|
1 | | -# Temporal |
2 | 1 | [](https://buildkite.com/temporal/temporal-server) |
3 | 2 | [](https://coveralls.io/github/temporalio/temporal?branch=master) |
4 | 3 | [](https://community.temporal.io) |
5 | 4 |
|
6 | | -Visit [docs.temporal.io](https://docs.temporal.io) to learn about Temporal. |
| 5 | +# Temporal |
| 6 | + |
| 7 | +Temporal is a microservice orchestration platform which enables developers to build scalable applications without sacrificing productivity or reliability. |
| 8 | +Temporal server executes units of application logic, Workflows, in a resilient manner that automatically handles intermittent failures, and retries failed operations. |
7 | 9 |
|
8 | | -This repo contains the source code of the Temporal server. To implement workflows, activities and worker use [Go SDK](https://github.com/temporalio/sdk-go) or [Java SDK](https://github.com/temporalio/sdk-java). |
| 10 | +Temporal is a mature technology, a fork of Uber's Cadence. |
| 11 | +Temporal is being developed by [Temporal Technologies](https://temporal.io/), a startup by the creators of Cadence. |
9 | 12 |
|
10 | | -See Maxim's talk at [Data@Scale Conference](https://atscaleconference.com/videos/cadence-microservice-architecture-beyond-requestreply) for an architectural overview of Temporal. |
| 13 | +[](http://www.youtube.com/watch?v=f-18XztyN6c "Temporal") |
| 14 | + |
| 15 | +Learn more about Temporal at [docs.temporal.io](https://docs.temporal.io). |
11 | 16 |
|
12 | 17 | ## Getting Started |
13 | 18 |
|
14 | | -### Start the temporal-server locally |
| 19 | +### Download and Start Temporal Server Locally |
| 20 | + |
| 21 | +Execute the following commands to start a pre-built image along with all the dependencies. |
15 | 22 |
|
16 | | -We highly recommend that you use [Temporal service docker](docker/README.md) to run the service. |
| 23 | +```bash |
| 24 | +$ curl -L https://github.com/temporalio/temporal/releases/latest/download/docker.tar.gz | tar -xz |
| 25 | +$ cd docker |
| 26 | +$ docker-compose up |
| 27 | +``` |
| 28 | + |
| 29 | +Refer to [Temporal service docker](docker/README.md) for more advanced options. |
17 | 30 |
|
18 | 31 | ### Run the Samples |
19 | 32 |
|
20 | | -Try out the sample recipes for [Go](https://github.com/temporalio/samples-go) or [Java](https://github.com/temporalio/samples-java) to get started. |
| 33 | +Clone or download samples for [Go](https://github.com/temporalio/samples-go) or [Java](https://github.com/temporalio/samples-java) and run them with the local Temporal server. |
| 34 | +We have a number of [HelloWorld type scenarios](https://github.com/temporalio/samples-java#helloworld) available, as well as more advanced ones. Note that the sets of samples are currently different between Go and Java. |
21 | 35 |
|
22 | 36 | ### Use CLI |
23 | 37 |
|
24 | | -Try out [Temporal command-line tool](tools/cli/README.md) to perform various tasks on Temporal |
| 38 | +Use [Temporal's command line tool](https://docs.temporal.io/docs/tctl) `tctl` to interact with the local Temporal server. |
| 39 | + |
| 40 | +```bash |
| 41 | +$ alias tctl="docker run --rm temporalio/tctl:latest --address host.docker.internal:7233" |
| 42 | +$ tctl namespace list |
| 43 | +$ tctl workflow list |
| 44 | +``` |
| 45 | + |
| 46 | +### Use Temporal Web UI |
25 | 47 |
|
26 | | -### Use Temporal Web |
| 48 | +Try [Temporal Web UI](https://github.com/temporalio/web) by opening [http://localhost:8088](http://localhost:8088)for viewing your sample workflows executing on Temporal. |
27 | 49 |
|
28 | | -Try out [Temporal Web UI](https://github.com/temporalio/web) to view your workflows on Temporal. |
29 | | -(This is already available at localhost:8088 if you run Temporal with docker compose) |
| 50 | +## Repository |
| 51 | + |
| 52 | +This repository contains the source code of the Temporal server. To implement Workflows, Activities and Workers, use [Go SDK](https://github.com/temporalio/sdk-go) or [Java SDK](https://github.com/temporalio/sdk-java). |
30 | 53 |
|
31 | 54 | ## Contributing |
32 | 55 |
|
33 | 56 | We'd love your help in making Temporal great. Please review our [contribution guide](CONTRIBUTING.md). |
34 | 57 |
|
35 | | -If you'd like to work on or propose a new feature, first peruse [feature requests](https://community.temporal.io/c/feature-requests/6) and our [proposals repo](https://github.com/temporalio/proposals) to discover existing active and accepted proposals. Feel free to join the Temporal [Slack channel](https://join.slack.com/t/temporalio/shared_invite/zt-c1e99p8g-beF7~ZZW2HP6gGStXD8Nuw) to start a discussion or check if a feature has already been discussed. Once you're sure the proposal is not covered elsewhere, please follow our [proposal instructions](https://github.com/temporalio/proposals#creating-a-new-proposal) or submit a [feature request](https://community.temporal.io/c/feature-requests/6). |
| 58 | +If you'd like to work on or propose a new feature, first peruse [feature requests](https://community.temporal.io/c/feature-requests/6) and our [proposals repo](https://github.com/temporalio/proposals) to discover existing active and accepted proposals. |
| 59 | + |
| 60 | +Feel free to join the Temporal [Slack channel](https://join.slack.com/t/temporalio/shared_invite/zt-c1e99p8g-beF7~ZZW2HP6gGStXD8Nuw) to start a discussion or check if a feature has already been discussed. |
| 61 | +Once you're sure the proposal is not covered elsewhere, please follow our [proposal instructions](https://github.com/temporalio/proposals#creating-a-new-proposal) or submit a [feature request](https://community.temporal.io/c/feature-requests/6). |
36 | 62 |
|
37 | 63 | ## License |
38 | 64 |
|
39 | | -MIT License, please see [LICENSE](https://github.com/temporalio/temporal/blob/master/LICENSE) for details. |
| 65 | +[MIT License](https://github.com/temporalio/temporal/blob/master/LICENSE) |
0 commit comments