You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: references/README.md
+33-7Lines changed: 33 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -52,13 +52,31 @@ This guide assumes that you have followed the [Contributing.md](https://github.c
52
52
53
53
#### Step-by-Step Instructions
54
54
55
-
1.**Run the webapp on localhost**:
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.
57
+
- Download the ngrok CLI. This can be done by following the instructions on ngrok's [website](https://ngrok.com/docs/getting-started/).
58
+
- Create an account on ngrok to obtain the authtoken and add it to the CLI.
59
+
```
60
+
ngrok config add-authtoken <your-auth-token>
61
+
```
62
+
Replace the <your-auth-token> with the token you obtain from ngrok.
63
+
- Run the tunnel.
64
+
```
65
+
ngrok http <your-app-port>
66
+
```
67
+
Replace the <your-app-port> with the webapp port, default is `3030`.
68
+
69
+
2.**Add your tunnel URL to the env**:
70
+
After running the ngrok tunnel, you will see URL in your terminal, it will look something like `https://<your-tunnel-address>.ngrok-free.app`.
71
+
Replace the `APP_ORIGIN` variable with this URL in your `.env` file in the root of the trigger.dev project.
72
+
73
+
3.**Run the webapp on localhost**:
56
74
57
75
```
58
76
pnpm run dev --filter webapp --filter coordinator --filter docker-provider
59
77
```
60
78
61
-
2.**Build the CLI in a new terminal window**:
79
+
4.**Build the CLI in a new terminal window**:
62
80
63
81
```
64
82
# Build the CLI
@@ -68,34 +86,42 @@ pnpm run build --filter trigger.dev
68
86
pnpm i
69
87
```
70
88
71
-
3.**Set up a new project in the webapp**:
89
+
5.**Set up a new project in the webapp**:
72
90
- Open the webapp running on `localhost:3030`.
73
91
- Create a new project in the webapp UI.
74
92
- Go to the *Project Settings* page and copy the project reference id from there.
0 commit comments