Skip to content

Commit

Permalink
[HUB-806]: Add API Key to onboarding docs (#42)
Browse files Browse the repository at this point in the history
* add api key to onboarding docs
  • Loading branch information
Nathan-Ballantyne authored Jan 10, 2024
1 parent 4268165 commit a773bc0
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ Set the onboarding private key in `.env`. Your private key will be used to creat
OWNER_ACCOUNT_PRIVATE_KEY=YOUR_PRIVATE_KEY
```

Set the `API_KEY` in the `.env` file. You can create and manage your API key in the [Immutable Hub](https://hub.immutable.com/). The Immutable Hub serves as a portal for creating, displaying, and refreshing API keys. Navigate to the "API Keys" menu item within your chosen project and environment to manage or create your API keys.

```sh
API_KEY=YOUR_SECRET_API_KEY
```

Install dependencies

```sh
Expand Down Expand Up @@ -80,6 +86,7 @@ _Requires environment variables `OWNER_ACCOUNT_PRIVATE_KEY`, `COLLECTION_PROJECT
```sh
npm run onboarding:create-collection
```

If you see a `replacement transaction underpriced` error message when trying to run `create-collection` please try again in 5 minutes.

## 4. Add metadata schema to your collection
Expand Down

0 comments on commit a773bc0

Please sign in to comment.