Skip to content

Commit c815f28

Browse files
authored
Update contributing instructions (#1121)
* Add OPEN_API_KEY env var in example file * Update prerequisites and first-time setup
1 parent c092c0f commit c815f28

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ branch are tagged into a release periodically.
1717
- [Node.js](https://nodejs.org/en) version 20.11.1
1818
- [pnpm package manager](https://pnpm.io/installation) version 8.15.5
1919
- [Docker](https://www.docker.com/get-started/)
20+
- [protobuf](https://github.com/protocolbuffers/protobuf)
2021

2122
### Setup
2223

@@ -102,13 +103,17 @@ First, make sure you are running the webapp according to the instructions above.
102103
4. Build the CLI
103104
104105
```sh
106+
# Build the CLI
105107
pnpm run build --filter trigger.dev
108+
# Make it accessible to `pnpm exec`
109+
pnpm i
106110
```
107111

108112
5. Change into the `<root>/references/v3-catalog` directory and authorize the CLI to the local server:
109113

110114
```sh
111115
cd references/v3-catalog
116+
cp .env.example .env
112117
pnpm exec triggerdev login -a http://localhost:3030
113118
```
114119

references/v3-catalog/.env.example

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
TRIGGER_SECRET_KEY=
2-
TRIGGER_API_URL=
2+
TRIGGER_API_URL=
3+
OPENAI_API_KEY="My API Key"

0 commit comments

Comments
 (0)