Skip to content

Commit f9494f2

Browse files
committed
minor language improvement
1 parent dd2a2ac commit f9494f2

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

references/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,16 +52,18 @@ This guide assumes that you have followed the [Contributing.md](https://github.c
5252

5353
#### Step-by-Step Instructions
5454

55-
1. **Run a http tunnel**:
56-
You will need to run a http tunnel to expose your local webapp, it is required for some API calls during building the image to deploy on your local instance. This is *optional* if you do not plan to test deployment on your local instance.
55+
1. **Run an HTTP tunnel**:
56+
You will need to run an HTTP tunnel to expose your local webapp, it is required for some API calls during building the image to deploy on your local instance. This is *optional* if you do not plan to test deployment on your local instance.
5757
- Download the ngrok CLI. This can be done by following the instructions on ngrok's [website](https://ngrok.com/docs/getting-started/).
5858
- Create an account on ngrok to obtain the authtoken and add it to the CLI.
59-
```
59+
60+
```bash
6061
ngrok config add-authtoken <your-auth-token>
6162
```
6263
Replace the <your-auth-token> with the token you obtain from ngrok.
6364
- Run the tunnel.
64-
```
65+
66+
```bash
6567
ngrok http <your-app-port>
6668
```
6769
Replace the <your-app-port> with the webapp port, default is `3030`.
@@ -72,13 +74,13 @@ Replace the `APP_ORIGIN` variable with this URL in your `.env` file in the root
7274

7375
3. **Run the webapp on localhost**:
7476

75-
```
77+
```bash
7678
pnpm run dev --filter webapp --filter coordinator --filter docker-provider
7779
```
7880

7981
4. **Build the CLI in a new terminal window**:
8082

81-
```
83+
```bash
8284
# Build the CLI
8385
pnpm run build --filter trigger.dev
8486

@@ -93,7 +95,7 @@ pnpm i
9395

9496
6. **Copy the hello-world project as a template**:
9597

96-
```
98+
```bash
9799
cp -r references/hello-world references/<new-project>
98100
```
99101

@@ -109,19 +111,19 @@ Replace `<new-project>` with your desired project name.
109111

110112
8. **Authorize the CLI for your project**:
111113

112-
```
114+
```bash
113115
pnpm exec trigger login -a http://localhost:3030 --profile local
114116
```
115117

116118
9. **Run the new project**:
117119
You can now run your project using the CLI with the following command:
118120

119-
```
121+
```bash
120122
pnpm exec trigger dev --profile local
121123
```
122124

123125
You can also deploy them against your local instance with the following command:
124126

125-
```
127+
```bash
126128
pnpm exec trigger deploy --self-hosted --load-image --profile local
127129
```

0 commit comments

Comments
 (0)