Skip to content

Commit

Permalink
Update contributing instructions (#1121)
Browse files Browse the repository at this point in the history
* Add OPEN_API_KEY env var in example file

* Update prerequisites and first-time setup
  • Loading branch information
codenem committed May 22, 2024
1 parent c092c0f commit c815f28
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ branch are tagged into a release periodically.
- [Node.js](https://nodejs.org/en) version 20.11.1
- [pnpm package manager](https://pnpm.io/installation) version 8.15.5
- [Docker](https://www.docker.com/get-started/)
- [protobuf](https://github.com/protocolbuffers/protobuf)

### Setup

Expand Down Expand Up @@ -102,13 +103,17 @@ First, make sure you are running the webapp according to the instructions above.
4. Build the CLI

```sh
# Build the CLI
pnpm run build --filter trigger.dev
# Make it accessible to `pnpm exec`
pnpm i
```

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

```sh
cd references/v3-catalog
cp .env.example .env
pnpm exec triggerdev login -a http://localhost:3030
```

Expand Down
3 changes: 2 additions & 1 deletion references/v3-catalog/.env.example
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
TRIGGER_SECRET_KEY=
TRIGGER_API_URL=
TRIGGER_API_URL=
OPENAI_API_KEY="My API Key"

0 comments on commit c815f28

Please sign in to comment.