Skip to content

Clarify README environment setup steps #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eltontay-circle wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify README environment setup steps #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,17 @@ Circle Gateway batches many signed offchain authorizations into a single onchain
cp .env.example .env.local
```

Then edit `.env.local` and fill in all required values (see [Environment Variables](#environment-variables) section below).
Then edit `.env.local` and fill in the required values listed in [Environment Variables](#environment-variables):
- Add the three Supabase values after completing step 4 below.
- For the wallet values, either enter your own testnet wallets or run step 3 to generate them automatically.

3. Generate seller and buyer wallets:

```bash
npm run generate-wallets
```

This creates two EVM wallets (seller and buyer) and writes the addresses and private keys to `.env.local`. Follow the on-screen instructions to fund the buyer wallet with testnet USDC via the [Circle faucet](https://faucet.circle.com/).
This optional step creates two EVM wallets (seller and buyer) and writes the addresses and private keys to `.env.local`. Use it if you do not want to provide your own wallet values manually. Follow the on-screen instructions to fund the buyer wallet with testnet USDC via the [Circle faucet](https://faucet.circle.com/).

4. Set up the database — Choose one of the two paths below:

Expand Down Expand Up @@ -158,6 +160,17 @@ BUYER_PRIVATE_KEY=0xYourBuyerPrivateKey
# OPENAI_API_KEY=your-openai-api-key
```

Required before the app can connect to Supabase:

- `NEXT_PUBLIC_SUPABASE_URL`
- `NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY`
- `SUPABASE_SERVICE_ROLE_KEY`

For wallet values, choose one setup path:

- Run `npm run generate-wallets` to auto-populate `SELLER_ADDRESS`, `SELLER_PRIVATE_KEY`, `BUYER_ADDRESS`, and `BUYER_PRIVATE_KEY` in `.env.local`.
- Or enter those four wallet values yourself if you already have testnet wallets you want to use.

| Variable | Scope | Purpose |
| --- | --- | --- |
| `NEXT_PUBLIC_SUPABASE_URL` | Public | Supabase project URL. |
Expand Down