-
Notifications
You must be signed in to change notification settings - Fork 759
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update readme * Fix casing * Add a better video still * Address feedback * Update statement about samples * Recommit video.png with LFS settings. * Cut a sentence to make intro more concise
- Loading branch information
1 parent
b827869
commit 764b9e4
Showing
2 changed files
with
42 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,65 @@ | ||
# Temporal | ||
[![Build status](https://badge.buildkite.com/fc0e676d7bee1a159916af52ebdb541708d4b9f88b8a980f6b.svg)](https://buildkite.com/temporal/temporal-server) | ||
[![Coverage Status](https://coveralls.io/repos/github/temporalio/temporal/badge.svg?branch=master)](https://coveralls.io/github/temporalio/temporal?branch=master) | ||
[![Discourse](https://img.shields.io/static/v1?label=Discourse&message=Get%20Help&color=informational)](https://community.temporal.io) | ||
|
||
Visit [docs.temporal.io](https://docs.temporal.io) to learn about Temporal. | ||
# Temporal | ||
|
||
Temporal is a microservice orchestration platform which enables developers to build scalable applications without sacrificing productivity or reliability. | ||
Temporal server executes units of application logic, Workflows, in a resilient manner that automatically handles intermittent failures, and retries failed operations. | ||
|
||
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). | ||
Temporal is a mature technology, a fork of Uber's Cadence. | ||
Temporal is being developed by [Temporal Technologies](https://temporal.io/), a startup by the creators of Cadence. | ||
|
||
See Maxim's talk at [Data@Scale Conference](https://atscaleconference.com/videos/cadence-microservice-architecture-beyond-requestreply) for an architectural overview of Temporal. | ||
[![Temporal](video.png)](http://www.youtube.com/watch?v=f-18XztyN6c "Temporal") | ||
|
||
Learn more about Temporal at [docs.temporal.io](https://docs.temporal.io). | ||
|
||
## Getting Started | ||
|
||
### Start the temporal-server locally | ||
### Download and Start Temporal Server Locally | ||
|
||
Execute the following commands to start a pre-built image along with all the dependencies. | ||
|
||
We highly recommend that you use [Temporal service docker](docker/README.md) to run the service. | ||
```bash | ||
$ curl -L https://github.com/temporalio/temporal/releases/latest/download/docker.tar.gz | tar -xz | ||
$ cd docker | ||
$ docker-compose up | ||
``` | ||
|
||
Refer to [Temporal service docker](docker/README.md) for more advanced options. | ||
|
||
### Run the Samples | ||
|
||
Try out the sample recipes for [Go](https://github.com/temporalio/samples-go) or [Java](https://github.com/temporalio/samples-java) to get started. | ||
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. | ||
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. | ||
|
||
### Use CLI | ||
|
||
Try out [Temporal command-line tool](tools/cli/README.md) to perform various tasks on Temporal | ||
Use [Temporal's command line tool](https://docs.temporal.io/docs/tctl) `tctl` to interact with the local Temporal server. | ||
|
||
```bash | ||
$ alias tctl="docker run --rm temporalio/tctl:latest --address host.docker.internal:7233" | ||
$ tctl namespace list | ||
$ tctl workflow list | ||
``` | ||
|
||
### Use Temporal Web UI | ||
|
||
### Use Temporal Web | ||
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. | ||
|
||
Try out [Temporal Web UI](https://github.com/temporalio/web) to view your workflows on Temporal. | ||
(This is already available at localhost:8088 if you run Temporal with docker compose) | ||
## Repository | ||
|
||
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). | ||
|
||
## Contributing | ||
|
||
We'd love your help in making Temporal great. Please review our [contribution guide](CONTRIBUTING.md). | ||
|
||
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). | ||
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). | ||
|
||
## License | ||
|
||
MIT License, please see [LICENSE](https://github.com/temporalio/temporal/blob/master/LICENSE) for details. | ||
[MIT License](https://github.com/temporalio/temporal/blob/master/LICENSE) |