{"id":13502981,"url":"https://github.com/alexkehayias/woz","last_synced_at":"2025-03-29T13:30:26.604Z","repository":{"id":37359269,"uuid":"168091062","full_name":"alexkehayias/woz","owner":"alexkehayias","description":"Woz is a progressive WebAssembly app (PWAA) generator for Rust.","archived":true,"fork":false,"pushed_at":"2020-05-20T04:20:50.000Z","size":3776,"stargazers_count":170,"open_issues_count":4,"forks_count":12,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-04-26T00:25:06.702Z","etag":null,"topics":["pwa","rust","wasm","wasm-bindgen","webassembly"],"latest_commit_sha":null,"homepage":"https://woz.sh","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexkehayias.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-29T04:49:57.000Z","updated_at":"2024-01-12T01:21:55.000Z","dependencies_parsed_at":"2022-09-12T23:51:44.107Z","dependency_job_id":null,"html_url":"https://github.com/alexkehayias/woz","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexkehayias%2Fwoz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexkehayias%2Fwoz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexkehayias%2Fwoz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexkehayias%2Fwoz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexkehayias","download_url":"https://codeload.github.com/alexkehayias/woz/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246068282,"owners_count":20718503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pwa","rust","wasm","wasm-bindgen","webassembly"],"created_at":"2024-07-31T22:02:32.531Z","updated_at":"2025-03-29T13:30:26.132Z","avatar_url":"https://github.com/alexkehayias.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/alexkehayias/woz.svg?branch=master)](https://travis-ci.org/alexkehayias/woz)\n\n# What is Woz?\n\n[Woz](https://woz.sh) is a progressive WebAssembly app (PWAA) generator for Rust.\n\n## Docs\n\nSee https://woz.sh for the latest docs.\n\n## Quickstart\n\nBefore we begin you must have a recent version of [Rust](https://www.rust-lang.org) installed as well as [wasm-bindgen](https://github.com/rustwasm/wasm-bindgen).\n\n### Install `wasm-bindgen`\n\nWoz uses `wasm-bindgen` to generate the interop calls between WebAssembly and JavaScript. This allows you to write the entire application in Rust—including rendering to the dom.\n\n```\ncargo install -f wasm-bindgen-cli\n```\n\n### Install wasm compiler target\n\n```\nrustup target add wasm32-unknown-unknown\n```\n\n\n### Install Woz\n\nInstall a pre-built binary.\n\nFor macOS (64 bit only):\n\n```sh\ncurl -LSfs https://woz.sh/bin/install.sh | sh -s -- --target x86_64-apple-darwin\n```\n\nFor linux (via musl):\n\n```sh\ncurl -LSfs https://woz.sh/bin/install.sh | sh -s -- --target x86_64-unknown-linux-musl\n```\n\nFor bsd:\n\n```sh\ncurl -LSfs https://woz.sh/bin/install.sh | sh -s -- --target x86_64-unknown-freebsd\n```\n\n```sh\ncurl -LSfs https://woz.sh/bin/install.sh | sh -s -- --target x86_64-unknown-netbsd\n```\n\n#### Updating\n\nTo update to the latest version of `woz` run the following command.\n\n```sh\ncurl -LSfs https://woz.sh/bin/install.sh | sh -s -- -f --target \u003cNAME OF TARGET\u003e\n```\n\n### Setup and deploy\n\n```sh\n# Follow prompts to create a free account and deploy to the sandbox\nwoz signup\n# Create a new app\nwoz new myapp \u0026\u0026 cd myapp\n# Deploy it\nwoz deploy\n```\n\n## Examples\n\nThe '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](https://woz.sh/us-west-2:f72ab923-2251-4e0d-925e-f3a4408ec70e/seed/index.html)\n\n## Self-hosting\n\nYou 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.\n\nBuild the app locally:\n\n```\ncd myapp/\nwoz build\n```\n\nFollow the cli output to get the location of the generated app files on disk. It will look something like:\n\n```\nApp package directory can be found at /Users/myusername/.woz/myapp/pkg\n```\n\nThe `app` directory contains an `index.html` file that will be the entry point for running the app in a browser.\n\nNote: 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.\n\nYou can also build Woz so that it can use your AWS account and allow multiple users to securely deploy apps to a shared S3 bucket. See https://woz.sh for the latest docs.\n\n## License\n\nEclipse Public License 1.0 (EPL-1.0)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexkehayias%2Fwoz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexkehayias%2Fwoz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexkehayias%2Fwoz/lists"}