Skip to content

Commit 2413f7e

Browse files
committed
chore: Update README with tweaks and improvements
* Move `.env` setup into code block, so it's easy to copy and paste. * Add `pnpm install` step, too. * Explain how to deal with Stripe in dev. * Fix reference to top-level page file (looks like this wasn't updated with the upgrade to the App Router), and hyperlink it. * Highlight .env file code blocks
1 parent 698974b commit 2413f7e

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

+19-7
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,40 @@ Upload files & manage your spaces from your browser.
88

99
To use the production site visit https://console.web3.storage
1010

11-
To contribute and customize console, copy `.env.tpl` to `.env` and run the development server:
11+
To contribute and customize console:
1212

1313
```bash
14+
# First-time setup
15+
cp .env.tpl .env
16+
pnpm install
17+
18+
# Run dev server
1419
pnpm dev
1520
```
1621

1722
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1823

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
24+
You can start editing the page by modifying [`src/app/page.tsx`](src/app/page.tsx). The page auto-updates as you edit the file.
2025

21-
### Using an alternate w3up service
26+
### Payment Info
2227

23-
By default, this app connects to https://up.web3.storage. To use an alternate service, specify
24-
the service URL and DID in your environment variables, like:
28+
Normally, a new account must first add payment information through Stripe. You can skip this by setting in your `.env`:
2529

30+
```ini
31+
NEXT_PUBLIC_DISABLE_PLAN_GATE=false
2632
```
33+
34+
You can also go through the Stripe flow if you wish, [using a Stripe test card](https://docs.stripe.com/testing#use-test-cards).
35+
36+
### Using an alternate w3up service
37+
38+
By default, this app connects to https://staging.up.web3.storage. To use an alternate service, specify the service URL and DID in your .env, like:
39+
40+
```ini
2741
NEXT_PUBLIC_W3UP_SERVICE_URL=https://your.w3up.service
2842
NEXT_PUBLIC_W3UP_SERVICE_DID=did:your-service-did
2943
```
3044

31-
An example `.env.local` file can be found in `.env.tpl`.
32-
3345
If you are using `w3infra`, the service URL will be displayed as the `UploadApiStack`'s `ApiEndpoint` output once `npm start` has successfully set up your development environment.
3446

3547
<p style="text-align:center;padding-top:2rem">⁂</p>

0 commit comments

Comments
 (0)