What is Woz?
Woz is a is a progressive WebAssembly app (PWAA) generator for Rust. Apps can be installed to your home screen and shared with a hyperlink.
cargo install -f wasm-bindgen-cli
Install wasm compiler target
rustup target add wasm32-unknown-unknown
Install a pre-built binary.
For macOS (64 bit only):
curl -LSfs https://woz.sh/bin/install.sh | sh -s -- --target x86_64-apple-darwin
For linux (via musl):
curl -LSfs https://woz.sh/bin/install.sh | sh -s -- --target x86_64-unknown-linux-musl
curl -LSfs https://woz.sh/bin/install.sh | sh -s -- --target x86_64-unknown-freebsd
curl -LSfs https://woz.sh/bin/install.sh | sh -s -- --target x86_64-unknown-netbsd
To update to the latest version of
woz run the following command.
curl -LSfs https://woz.sh/bin/install.sh | sh -s -- -f --target <NAME OF TARGET>
Setup and deploy
# Follow prompts to create your free Woz account woz signup # Create a new app woz new myapp && cd myapp # Deploy it woz deploy
The 'Seed' example app uses the
seed framework and clocks in at ~600kb (including ~300kb for an icon and splashscreen), works offline, and can be installed to your homescreen on iOS or Android devices. You can try it out here
Woz.sh Early Access—Free
Due to the security requirements of PWAs and WebAssembly, the easiest way to deploy is to create a free woz.sh account. To create an account use
woz signup and follow the prompts. If you already have an account use
woz setup to set up your local computer with credentials. Then use
woz deploy to deploy your app.
You can self-host by using
woz to build your app locally and upload the files to your static file hosting service such as AWS S3.
Build the app locally:
cd myapp/ woz build
Follow the cli output to get the location of the generated app files on disk. It will look something like:
App package directory can be found at /Users/myusername/.woz/myapp/pkg
app directory contains an
index.html file that will be the entry point for running the app in a browser.
Note: the security requirements for PWAs and WebAssembly means you will need to serve the files over https. Browsing the files directly in the browser (e.g.
file://) will result in security-related errors. Use a static file server and install an SSL certificate to be able to install the app to your home screen.
Multi-user AWS hosting
You can compile
woz so that it uses your AWS account and allow for multiple users to securely deploy apps to a shared S3 bucket.
To do that, clone the Woz repo locally and put the following environment variables in a file:
# Scheme to use when constructing URLs to your app WOZ_WEB_SCHEME="https" # Domain to use links to your app WOZ_WEB_NETLOC="example.com" # Cognito identity pool to use for user registration WOZ_USER_POOL_URL="cognito-idp.<REGION>.amazonaws.com/<USER POOL ID>" # Cognito identity pool to use for authentication WOZ_IDENTITY_POOL_ID="<REGION>:<IDENTITY POOL ID>" # Cognito user pool app client to use for use with the CLI WOZ_CLIENT_ID="<USER POOL APP CLIENT ID>" # S3 bucket where static files will be stored WOZ_S3_BUCKET_NAME="<S3 BUCKET NAME>" # Password used for encrypting tokens on disk WOZ_ENCRYPTION_PASSWORD="<STRONG PASSWORD>" # Salt used for encrypting tokens on disk WOZ_ENCRYPTION_SALT="<RANDOM SALT>" # Location of the woz repo, needed to generate new projects WOZ_PROJECT_ROOT="<PATH TO WOZ REPO>" # Location of the woz repo, needed to include assets WOZ_CLI_PROJECT_ROOT="<PATH TO WOZ REPO>/cli"
In your terminal, add the environment variables to the session:
set -a; . ../my-env; set +a
You can now build and deploy to your own AWS account. For example:
cargo run setup cargo run new myapp cargo run deploy --project-root ./myapp