Merge pull request #55 from polywrap/develop

Release 0.4.3

Author: nerfZael

Cargo.lock

@@ -22,6 +22,7 @@ members = [
     "examples/http-server-app",
     "examples/simple-storage-app",
     "examples/advanced-server-app",
+    "examples/app-with-ui",
 ]
 
 default-members = [
@@ -40,6 +41,7 @@ default-members = [
     "examples/http-server-app",
     "examples/simple-storage-app",
     "examples/advanced-server-app",
+    "examples/app-with-ui",
 ]
 
 [workspace.dependencies]

Cargo.toml

@@ -20,63 +20,9 @@ Then, to install `pwr`, run:
 ```bash
 pwrup
 ```
-## Script WRAPS (JS and Python)
-{lang} = js | py
 
-### REPL
-`pwr {lang} repl`
-Runs a REPL where you can type scripts.
-
-`pwr {lang} repl -f {name_of_file}`
-Runs the repl over a file.
-It will read and execute the file first (and create it if it doesn't exist).
-It will also store all CLI commands you type inside of it (after evaluating them).
-Press enter in the CLI to re-run the whole file (useful if you want to code in the file instead of the CLI).
-
-`pwr {lang} repl -f {name_of_file} -w`
-It will read and execute the file first (and create it if it doesn't exist).
-Then it will execute the file every time you save it.
-It will not listen to CLI input if you use this option ("-w").
-
-### New 
-`pwr {lang} new -f {name_of_file}`
-Creates a new file of the specified name for the script wrap.
-It uses a template for that language.
-
-### Build
-`pwr {lang} build -f {name_of_file}`
-Builds the target script file.
-
-### Deploy
-`pwr deploy`
-Deploys the build directory.
-
-`pwr {lang} deploy`
-Deploys the build directory. (Same as `pwr deploy`)
-
-`pwr {lang} deploy -f {name_of_file}`
-Builds and then deploys the script file.
-
-## TODO: Examples PWR app usage: 
-Input: `pwr wrap://ens/wrap-echo.eth Hello world!`
-Output: `Hello world!`
-
-Input: `pwr ens/wrap-echo.eth Hello world!`
-Output: `Hello world!`
-
-Input: `pwr wrap-echo.eth Hello world!`
-Output: `Hello world!`
-
-Input: `pwr wrap://ipfs/QmebzauKAXoYbywLAYdBvKyPhWsDoHfkUC4wffWvjighKT Hello world!`
-Output: `Hello world!`
-
-Input: `pwr ipfs/QmebzauKAXoYbywLAYdBvKyPhWsDoHfkUC4wffWvjighKT Hello world!`
-Output: `Hello world!`
-
-Input: `pwr ipfs://QmebzauKAXoYbywLAYdBvKyPhWsDoHfkUC4wffWvjighKT Hello world!`
-Output: `Hello world!`
-
-Input: `pwr QmebzauKAXoYbywLAYdBvKyPhWsDoHfkUC4wffWvjighKT Hello world!`
-Output: `Hello world!`
+[Example PWR Usage](./docs/pwr-usage.md)
 
+[Example PWR Apps](./docs/pwr-apps.md)
 
+[Script WRAPS Guide](./docs/script-wraps.md)

README.md

@@ -0,0 +1,7 @@
+# PWR App Examples
+
+- [Simple PWR App](../examples/simple-pwr-app/README.md)
+- [Simple Storage App](../examples/simple-storage-app/README.md)
+- [HTTP Server App](../examples/http-server-app/README.md)
+- [Advanced HTTP Server App](../examples/app-with-ui/README.md)
+- [PWR App with UI](../examples/app-with-ui/README.md)

docs/pwr-apps.md

@@ -0,0 +1,57 @@
+# Example PWR CLI usage:
+
+## Migration
+After running `pwrup`, you have to run `pwr migrate` to migrate your configuration to the latest version.
+
+## Running pwr apps
+
+### From wrapscan.io
+To run a pwr app from wrapscan.io, run:
+```bash
+pwr wrapscan.io/pwr/say-hello
+```
+
+### From wrappers.dev
+To run a pwr app from wrappers.dev, run:
+```bash
+pwr @pwr/say-hello
+```
+```bash
+pwr https/wrappers.dev/u/pwr/say-hello
+```
+
+### Local directory
+To run a pwr app from a local directory (e.g. `./build`), run:
+```bash
+pwr ./build
+```
+```bash
+pwr fs/build
+```
+
+### From IPFS
+To run a pwr app from IPFS, run:
+```bash
+pwr ipfs/Qm...
+```
+```bash
+pwr Qm...
+```
+```bash
+pwr ipfs://Qm...
+```
+
+### From ENS
+To run a pwr app from ENS, run:
+```bash
+pwr ens/say-hello.eth
+```
+```bash
+pwr say-hello.eth
+```
+
+## Passing arguments to pwr apps
+To pass arguments to a pwr app add them after the WRAP URI, e.g.:
+```bash
+pwr ./build arg1 arg2
+```

docs/pwr-usage.md

@@ -0,0 +1,36 @@
+# Script WRAPS (JS and Python)
+{lang} = js | py
+
+### REPL
+`pwr {lang} repl`
+Runs a REPL where you can type scripts.
+
+`pwr {lang} repl -f {name_of_file}`
+Runs the repl over a file.
+It will read and execute the file first (and create it if it doesn't exist).
+It will also store all CLI commands you type inside of it (after evaluating them).
+Press enter in the CLI to re-run the whole file (useful if you want to code in the file instead of the CLI).
+
+`pwr {lang} repl -f {name_of_file} -w`
+It will read and execute the file first (and create it if it doesn't exist).
+Then it will execute the file every time you save it.
+It will not listen to CLI input if you use this option ("-w").
+
+### New 
+`pwr {lang} new -f {name_of_file}`
+Creates a new file of the specified name for the script wrap.
+It uses a template for that language.
+
+### Build
+`pwr {lang} build -f {name_of_file}`
+Builds the target script file.
+
+### Deploy
+`pwr deploy`
+Deploys the build directory.
+
+`pwr {lang} deploy`
+Deploys the build directory. (Same as `pwr deploy`)
+
+`pwr {lang} deploy -f {name_of_file}`
+Builds and then deploys the script file.

docs/script-wraps.md

@@ -0,0 +1 @@
+!src/wrap

examples/app-with-ui/.gitignore

@@ -0,0 +1 @@
+v16.13.0

examples/app-with-ui/.nvmrc

@@ -0,0 +1,22 @@
+[package]
+name = "app_with_ui"
+version = "0.1.0"
+description = "An example of a PWR HTTP server application with UI"
+
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+
+[dependencies]
+polywrap_msgpack_serde.workspace = true
+polywrap-wasm-rs.workspace = true
+serde = { version = "1.0", features = ["derive"] }
+serde_bytes.workspace = true
+
+[lib]
+crate-type = ["cdylib"]
+
+[profile.release]
+opt-level = 's'
+lto = true
+panic = 'abort'

examples/app-with-ui/Cargo.toml

@@ -0,0 +1,2 @@
+# App with UI
+An example of a PWR HTTP server application with UI