Skip to content

Commit 54a2cc0

Browse files
committed
docs(readme): add more info
1 parent da51719 commit 54a2cc0

1 file changed

Lines changed: 33 additions & 16 deletions

File tree

README.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Run a [Temporal](https://temporal.io) hackathon
1313
* [Supported languages](#supported-languages)
1414
* [Your development environment](#your-development-environment)
1515
* [Codespaces](#codespaces)
16-
* [Dev Containers (local)](#dev-containers-local)
16+
* [Dev Containers](#dev-containers)
17+
* [Docker Compose](#docker-compose)
1718
* [Gitpod](#gitpod)
18-
* [Docker](#docker)
1919
* [Local development](#local-development)
2020
* [Optional dependencies](#optional-dependencies)
2121
* [Go](#go)
@@ -60,6 +60,12 @@ by [configuring these environment variables](https://docs.temporal.io/develop/en
6060

6161
## Resources
6262

63+
> [!NOTE]
64+
> [Temporal](https://temporal.io) is an open-source workflow orchestration platform
65+
> that allows developers to build reliable, long-running applications as simple
66+
> code. It ensures tasks run to completion by handling retries, failures, and
67+
> state management automatically.
68+
6369
* [What is Temporal?](https://docs.temporal.io/temporal)
6470
* [Introduction to Workflows](https://docs.temporal.io/workflows)
6571
* [What is an Activity?](https://docs.temporal.io/activities)
@@ -78,17 +84,23 @@ For this hackathon, see the individual languages:
7884
This is a hands-on hackathon, so you will need to write some code.
7985

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

8491
### Codespaces
8592

86-
[Codespaces](https://github.com/features/codespaces) is a remote development
87-
environment that allows one-click configuration of your development environment.
93+
> [!NOTE]
94+
> [Codespaces](https://github.com/features/codespaces) is a remote development
95+
> environment that allows one-click configuration of your development environment.
8896
8997
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/temporal-sa/hackathon-starter)
9098

91-
### Dev Containers (local)
99+
### Dev Containers
100+
101+
> [!NOTE]
102+
> [Dev Containers](https://containers.dev) allows you to use a container as a
103+
> full-featured development environment.
92104
93105
1. Install [Docker](https://www.docker.com/get-started/)
94106
1. Install [VSCode](https://code.visualstudio.com/) or [VSCode Insiders](https://code.visualstudio.com/insiders/)
@@ -97,16 +109,13 @@ environment that allows one-click configuration of your development environment.
97109
* Clone this repo and open in VSCode, or
98110
* [Open in Dev Containers](http://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/temporal-sa/hackathon-starter)
99111

100-
### Gitpod
101-
102-
[Gitpod](https://www.gitpod.io) is a remote development environment that allows
103-
one-click configuration of your development environment.
104-
105-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/temporal-sa/hackathon-starter)
106-
107-
### Docker
112+
### Docker Compose
108113

109-
> [!TIP]
114+
> [!NOTE]
115+
> Run the application inside [Docker Compose](https://docs.docker.com/compose).
116+
> This is **NOT** a development environment, but does allow you to run the whole
117+
> application stack on your local machine.
118+
>
110119
> This will run the Temporal UI on [localhost:8080](http://localhost:8080)
111120
112121
1. Enter the directory for the language you wish to develop in (eg, `cd golang`)
@@ -115,6 +124,14 @@ one-click configuration of your development environment.
115124
1. In one terminal window, run `docker compose up worker`
116125
1. In another terminal window, run `docker compose up starter`
117126

127+
### Gitpod
128+
129+
> [!NOTE]
130+
> [Gitpod](https://www.gitpod.io) is a remote development environment that allows
131+
> one-click configuration of your development environment.
132+
133+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/temporal-sa/hackathon-starter)
134+
118135
### Local development
119136

120137
> [!CAUTION]

0 commit comments

Comments
 (0)