Skip to content

Commit 87788f2

Browse files
committed
A v3 catalog readme
1 parent 6ede686 commit 87788f2

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

references/v3-catalog/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# The v3 catalog
2+
3+
You can test v3 tasks from inside the app in this project. It's designed to be used for testing features and functionality of the v3 SDK.
4+
5+
## One-time setup
6+
7+
1. In Postgres go to the "Organizations" table and on your org set the `v3Enabled` column to `true`.
8+
9+
2. Create a v3 project in the UI of the webapp, you should now be able to select it from the dropdown.
10+
11+
3. In Postgres go to the "Projects" table and for the project you create change the `externalRef` to `yubjwjsfkxnylobaqvqz`.
12+
13+
This is so the `trigger.config.ts` file inside the v3-catalog doesn't keep getting changed by people accidentally pushing this.
14+
15+
## How to use
16+
17+
1. Make sure you're running the main webapp
18+
19+
```bash
20+
pnpm run dev --filter webapp
21+
```
22+
23+
2. Build the v3 CLI (this needs to be done everytime a code changes is made to the CLI if you're working on it)
24+
25+
```bash
26+
pnpm run build --filter trigger.dev
27+
```
28+
29+
3. CD into the v3-catalog directory
30+
31+
```bash
32+
cd references/v3-catalog
33+
```
34+
35+
4. If you've never logged in to the CLI you'll see an error telling you to login. Do this:
36+
37+
```bash
38+
pnpm exec triggerdev login -a http://localhost:3030
39+
```
40+
41+
If this fails because you already are logged in you can create a new profile:
42+
43+
```bash
44+
pnpm exec triggerdev login -a http://localhost:3030 --profile local
45+
```
46+
47+
Note: if you use a profile then you'll need to append `--profile local` to all commands, like `dev`.
48+
49+
5. Run the v3 CLI
50+
51+
```bash
52+
pnpm exec triggerdev dev
53+
```
54+
55+
6. You should see the v3 dev command spitting out messages, including that it's started a background worker.

0 commit comments

Comments
 (0)