Skip to content
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

Jump to bottom

chore: Update README with tweaks and improvements #113

Open
wants to merge 1 commit into
base: old-main
Choose a base branch
from
Open

chore: Update README with tweaks and improvements #113

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
26 changes: 19 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,40 @@ Upload files & manage your spaces from your browser.

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

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

```bash
# First-time setup
cp .env.tpl .env
pnpm install

# Run dev server
pnpm dev
```

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

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
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.

### Using an alternate w3up service
### Payment Info

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

```ini
NEXT_PUBLIC_DISABLE_PLAN_GATE=false
```

You can also go through the Stripe flow if you wish, [using a Stripe test card](https://docs.stripe.com/testing#use-test-cards).

### Using an alternate w3up service

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:

```ini
NEXT_PUBLIC_W3UP_SERVICE_URL=https://your.w3up.service
NEXT_PUBLIC_W3UP_SERVICE_DID=did:your-service-did
```

An example `.env.local` file can be found in `.env.tpl`.

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.

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