Skip to content

Commit fef1670

Browse files
committed
Improved the testing CLI contributing guide
1 parent 3897e6e commit fef1670

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,25 +149,27 @@ pnpm create next-app@latest test-cli --ts --no-eslint --tailwind --app --src-dir
149149
}
150150
```
151151
152-
5. Back in the terminal, navigate into the example, and initialize the CLI:
152+
5. Back in the terminal, navigate into the example, and initialize the CLI. When prompted, select `self-hosted` and enter `localhost:3030` if you are testing against the local instance of Trigger.dev, or you can just use the Trigger.dev cloud. When asked for an API key, use the key you copied earlier.
153153
154154
```sh
155155
cd ./test-cli
156156
pnpm i
157157
pnpm exec trigger-cli init
158158
```
159159
160-
6. When prompted, select `self-hosted` and enter `localhost:3030` for your local version of the webapp. (You can also use the Trigger.dev cloud). When asked for an API key, use the key you copied earlier.
160+
6. If you are just testing the `init` command, you can stop here. If you'd like to test the `dev` command, first start the Next.js app on port 3000:
161161
162-
7. Run the CLI
162+
```sh
163+
pnpm run dev
164+
```
165+
166+
7. Open a new terminal window, and then run the `dev` command like so:
163167
164168
```sh
165169
pnpm exec trigger-cli dev
166170
```
167171
168-
8. After running the CLI, start your newly created Next.js project. You should now be able to see the changes.
169-
170-
9. Please remember to delete the temporary project you created after you've tested the changes, and before you raise a PR.
172+
8. Please remember to delete the temporary project you created after you've tested the changes, and before you raise a PR.
171173
172174
## Running end-to-end webapp tests
173175

0 commit comments

Comments
 (0)