@loadnetwork/permaweb-deploy 2.5.1-loadnetwork.0 → 2.5.1-loadnetwork.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,27 +1,37 @@
|
|
|
1
1
|
# Permaweb Deploy
|
|
2
2
|
|
|
3
|
-
Inspired by the [cookbook github action deployment guide](https://cookbook.arweave.dev/guides/deployment/github-action.html), `permaweb-deploy` is a Node.js command-line tool designed to streamline the deployment of web applications to the permaweb using Arweave. It uploads your build folder or a single file, creates Arweave manifests, and updates ArNS (Arweave Name Service) records via ANT (Arweave Name Token) with the transaction ID.
|
|
3
|
+
> Inspired by the [cookbook github action deployment guide](https://cookbook.arweave.dev/guides/deployment/github-action.html), `permaweb-deploy` is a Node.js command-line tool designed to streamline the deployment of web applications to the permaweb using Arweave. It uploads your build folder or a single file, creates Arweave manifests, and updates ArNS (Arweave Name Service) records via ANT (Arweave Name Token) with the transaction ID.
|
|
4
4
|
|
|
5
|
-
## Load S3
|
|
6
|
-
To use locally the load s3 `--preview` deployment integration:
|
|
5
|
+
## Load S3 integration
|
|
7
6
|
|
|
8
|
-
####
|
|
7
|
+
#### npmjs package install
|
|
9
8
|
|
|
10
9
|
```bash
|
|
10
|
+
npm i -g @loadnetwork/permaweb-deploy
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
#### dev install from source
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
git clone https://github.com/loadnetwork/permaweb-deploy
|
|
17
|
+
cd permaweb-deploy
|
|
18
|
+
|
|
11
19
|
pnpm install
|
|
12
20
|
pnpm build
|
|
13
21
|
|
|
14
22
|
pnpm link --global
|
|
15
23
|
```
|
|
16
24
|
|
|
25
|
+
To use the `@loadnetwork/permaweb-deploy` CLI, you can use either `load-permaweb-deploy` or the fork's canonical `permaweb-deploy` cli name. to avoid conflicts, we advise using `load-permaweb-dpeloy` for load's fork.
|
|
26
|
+
|
|
17
27
|
#### deploy
|
|
18
28
|
|
|
19
29
|
from your ui folder:
|
|
20
30
|
|
|
21
31
|
```bash
|
|
22
|
-
permaweb-deploy deploy --preview --deploy-folder ./dist --wallet ./wallet.json
|
|
32
|
+
load-permaweb-deploy deploy --preview --deploy-folder ./dist --wallet ./wallet.json
|
|
23
33
|
```
|
|
24
|
-
if you want to avoid linking, run it directly from the repo:
|
|
34
|
+
[dev] if you want to avoid linking, run it directly from the repo:
|
|
25
35
|
|
|
26
36
|
```bash
|
|
27
37
|
node ./bin/run.js deploy --preview --deploy-folder /path-to-dist/dist --wallet /path-to-wallet/wallet.json
|
|
@@ -31,7 +41,7 @@ node ./bin/run.js deploy --preview --deploy-folder /path-to-dist/dist --wallet /
|
|
|
31
41
|
to anchor load s3 preview deployment to Arweave while maintaining determinism and provenance:
|
|
32
42
|
|
|
33
43
|
```bash
|
|
34
|
-
permaweb-deploy deploy --anchor --preview-id <manifest-id> --wallet ./wallet.json
|
|
44
|
+
load-permaweb-deploy deploy --anchor --preview-id <manifest-id> --wallet ./wallet.json
|
|
35
45
|
```
|
|
36
46
|
|
|
37
47
|
### Resolving Arweave Manifests (Staging/Prod)
|