Skip to content

Commit

Permalink
fix: READMEs (#76)
Browse files Browse the repository at this point in the history
* add env templates

* update readmes
  • Loading branch information
groninge01 authored Oct 16, 2024
1 parent c5404df commit 9ce8e29
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 6 deletions.
16 changes: 16 additions & 0 deletions apps/beets-frontend-v3/.env.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
NEXT_PUBLIC_APP_ENV=dev
NEXT_PUBLIC_BALANCER_API_URL=https://api-v3.balancer.fi/graphql
NEXT_PUBLIC_WALLET_CONNECT_ID=1b6b722470b504a53cf011e1e629a9eb

# For wallet checks (optional)
PRIVATE_HYPERNATIVE_API_ID=xxx
PRIVATE_HYPERNATIVE_API_SECRET=xxx

# For fiat currency conversions (optional)
PRIVATE_CURRENCYAPI_KEY=xxx

# For integration tests and rpc proxy routes (optional)
NEXT_PRIVATE_DRPC_KEY=xxx

# Allow skip transaction (optional)
NEXT_PUBLIC_ALLOW_SKIP_TRANSACTION=true
2 changes: 2 additions & 0 deletions apps/beets-frontend-v3/.env.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
NEXT_PUBLIC_APP_ENV=test
NEXT_PUBLIC_BALANCER_API_URL=https://api-v3.balancer.fi/graphql
13 changes: 10 additions & 3 deletions apps/beets-frontend-v3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,25 @@ https://pnpm.io/installation_
To setup the development environment, first clone the repo:

```bash
git clone https://github.com/balancer/frontend-v3.git && cd beets-frontend-v3
git clone https://github.com/balancer/frontend-monorepo.git && cd frontend-monorepo/apps/beets-frontend-v3
```

Copy the `.env.example` file to `.env.local`:
Copy the `.env.template` file to `.env.local`:

```bash
cp .env.example .env.local
cp .env.template .env.local
```

Copy the `.env.local` file to `../../packages/lib`:

```bash
cp .env.local ../../packages/lib
```

Next, install dependencies:

```bash
cd ../..
pnpm install
```

Expand Down
16 changes: 16 additions & 0 deletions apps/frontend-v3/.env.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
NEXT_PUBLIC_APP_ENV=dev
NEXT_PUBLIC_BALANCER_API_URL=https://api-v3.balancer.fi/graphql
NEXT_PUBLIC_WALLET_CONNECT_ID=1b6b722470b504a53cf011e1e629a9eb

# For wallet checks (optional)
PRIVATE_HYPERNATIVE_API_ID=xxx
PRIVATE_HYPERNATIVE_API_SECRET=xxx

# For fiat currency conversions (optional)
PRIVATE_CURRENCYAPI_KEY=xxx

# For integration tests and rpc proxy routes (optional)
NEXT_PRIVATE_DRPC_KEY=xxx

# Allow skip transaction (optional)
NEXT_PUBLIC_ALLOW_SKIP_TRANSACTION=true
2 changes: 2 additions & 0 deletions apps/frontend-v3/.env.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
NEXT_PUBLIC_APP_ENV=test
NEXT_PUBLIC_BALANCER_API_URL=https://api-v3.balancer.fi/graphql
13 changes: 10 additions & 3 deletions apps/frontend-v3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,25 @@ https://pnpm.io/installation_
To setup the development environment, first clone the repo:

```bash
git clone https://github.com/balancer/frontend-v3.git && cd frontend-v3
git clone https://github.com/balancer/frontend-monorepo.git && cd frontend-monorepo/apps/frontend-v3
```

Copy the `.env.example` file to `.env.local`:
Copy the `.env.template` file to `.env.local`:

```bash
cp .env.example .env.local
cp .env.template .env.local
```

Copy the `.env.local` file to `../../packages/lib`:

```bash
cp .env.local ../../packages/lib
```

Next, install dependencies:

```bash
cd ../..
pnpm install
```

Expand Down

0 comments on commit 9ce8e29

Please sign in to comment.