Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 33 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Run a [Temporal](https://temporal.io) hackathon
* [Supported languages](#supported-languages)
* [Your development environment](#your-development-environment)
* [Codespaces](#codespaces)
* [Dev Containers (local)](#dev-containers-local)
* [Dev Containers](#dev-containers)
* [Docker Compose](#docker-compose)
* [Gitpod](#gitpod)
* [Docker](#docker)
* [Local development](#local-development)
* [Optional dependencies](#optional-dependencies)
* [Go](#go)
Expand Down Expand Up @@ -60,6 +60,12 @@ by [configuring these environment variables](https://docs.temporal.io/develop/en

## Resources

> [!NOTE]
> [Temporal](https://temporal.io) is an open-source workflow orchestration platform
> that allows developers to build reliable, long-running applications as simple
> code. It ensures tasks run to completion by handling retries, failures, and
> state management automatically.

* [What is Temporal?](https://docs.temporal.io/temporal)
* [Introduction to Workflows](https://docs.temporal.io/workflows)
* [What is an Activity?](https://docs.temporal.io/activities)
Expand All @@ -78,17 +84,23 @@ For this hackathon, see the individual languages:
This is a hands-on hackathon, so you will need to write some code.

You're free to use any development environment you wish, but we have provided
some pre-configured environments so you can started quicker. These are all supported
equally and you should choose the setup that you're most comfortable with.
some pre-configured environments so you can get started quicker. These are all
supported equally and you should choose the setup that you're most comfortable
with.

### Codespaces

[Codespaces](https://github.com/features/codespaces) is a remote development
environment that allows one-click configuration of your development environment.
> [!NOTE]
> [Codespaces](https://github.com/features/codespaces) is a remote development
> environment that allows one-click configuration of your development environment.

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/temporal-sa/hackathon-starter)

### Dev Containers (local)
### Dev Containers

> [!NOTE]
> [Dev Containers](https://containers.dev) allows you to use a container as a
> full-featured development environment.

1. Install [Docker](https://www.docker.com/get-started/)
1. Install [VSCode](https://code.visualstudio.com/) or [VSCode Insiders](https://code.visualstudio.com/insiders/)
Expand All @@ -97,16 +109,13 @@ environment that allows one-click configuration of your development environment.
* Clone this repo and open in VSCode, or
* [Open in Dev Containers](http://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/temporal-sa/hackathon-starter)

### Gitpod

[Gitpod](https://www.gitpod.io) is a remote development environment that allows
one-click configuration of your development environment.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/temporal-sa/hackathon-starter)

### Docker
### Docker Compose

> [!TIP]
> [!NOTE]
> Run the application inside [Docker Compose](https://docs.docker.com/compose).
> This is **NOT** a development environment, but does allow you to run the whole
> application stack on your local machine.
>
> This will run the Temporal UI on [localhost:8080](http://localhost:8080)

1. Enter the directory for the language you wish to develop in (eg, `cd golang`)
Expand All @@ -115,6 +124,14 @@ one-click configuration of your development environment.
1. In one terminal window, run `docker compose up worker`
1. In another terminal window, run `docker compose up starter`

### Gitpod

> [!NOTE]
> [Gitpod](https://www.gitpod.io) is a remote development environment that allows
> one-click configuration of your development environment.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/temporal-sa/hackathon-starter)

### Local development

> [!CAUTION]
Expand Down
Loading