Skip to content

Commit

Permalink
Merge pull request #48 from ar-io/update-readme
Browse files Browse the repository at this point in the history
chore: updated README.md
  • Loading branch information
kunstmusik authored Jul 12, 2024
2 parents fa73e66 + b27d24d commit 7ee10cd
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,32 @@
# network-portal
Application for interacting with the ar.io network.

A React web application for interacting with the ar.io network.

## Getting Started

### Run

```shell
yarn
yarn dev
```

### Build

```shell
yarn build
```

### Test

```shell
yarn test
```

## Deployment

The application release process deploys the application to the network-portal.app domain as well as to Arweave using [permaweb-deploy](https://github.com/permaweb/permaweb-deploy). Developers can deploy their own versions of the application to arweave using `yarn deploy`.

Running `yarn deploy` uses the following environment variables:

```
Expand All @@ -11,4 +35,12 @@ export DEPLOY_ANT_PROCESS_ID=[process id of the ant process to deploy to]
export DEPLOY_KEY=[base64 encoded version of wallet keyfile]
```

For local testing, you can create a deploy.sh script with the above valeus defined, run `source deploy.sh`, then use `yarn deploy`.
For local testing, you can create a deploy.sh script with the above values defined, run `source deploy.sh`, then use `yarn deploy`.

## Resources

* [ar.io](https://ar.io)
* [ar.io Whitepaper](https://whitepaper_ar-io.arweave.net/)
* [ar.io SDK](https://github.com/ar-io/ar-io-sdk)
* [arweave](https://arweave.org)
* [ao](https://ao.arweave.net/)

0 comments on commit 7ee10cd

Please sign in to comment.