https://github.com/cloudflare/rustwasm-worker-template

A template for kick starting a Cloudflare Worker project using workers-rs. Write your Cloudflare Worker entirely in Rust!
https://github.com/cloudflare/rustwasm-worker-template

Last synced: 18 days ago
JSON representation

A template for kick starting a Cloudflare Worker project using workers-rs. Write your Cloudflare Worker entirely in Rust!

• Host: GitHub
• URL: https://github.com/cloudflare/rustwasm-worker-template
• Owner: cloudflare
• License: apache-2.0
• Created: 2019-03-18T18:15:11.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-25T22:47:57.000Z (about 2 months ago)
• Last Synced: 2024-10-08T12:48:22.505Z (about 1 month ago)
• Language: Rust
• Homepage:
• Size: 35.2 KB
• Stars: 372
• Watchers: 16
• Forks: 62
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE_APACHE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-cloudflare - Hello World Rust Boilerplate - Template for kick starting a worker project using wasm-pack. (Workers / Recipes)
• awesome-cloudflare - Hello World Rust Boilerplate - Template for kick starting a worker project using wasm-pack. (Workers / Recipes)

README

        
# Getting Started

A template for kick starting a Cloudflare worker project using [`workers-rs`](https://github.com/cloudflare/workers-rs).

This template is designed for compiling Rust to WebAssembly and publishing the resulting worker to 

Cloudflare's [edge infrastructure](https://www.cloudflare.com/network/).

## Usage 

This template starts you off with a `src/lib.rs` file, acting as an entrypoint for requests hitting

your Worker. Feel free to add more code in this file, or create Rust modules anywhere else for this

project to use. 

With `wrangler`, you can build, test, and deploy your Worker with the following commands: 

```bash

# compiles your project to WebAssembly and will warn of any issues

wrangler build 

# run your Worker in an ideal development workflow (with a local server, file watcher & more)

wrangler dev

# deploy your Worker globally to the Cloudflare network (update your wrangler.toml file for configuration)

wrangler publish

```

Read the latest `worker` crate documentation here: https://docs.rs/worker

## WebAssembly

`workers-rs` (the Rust SDK for Cloudflare Workers used in this template) is meant to be executed as 

compiled WebAssembly, and as such so **must** all the code you write and depend upon. All crates and

modules used in Rust-based Workers projects have to compile to the `wasm32-unknown-unknown` triple. 

Read more about this on the [`workers-rs` project README](https://github.com/cloudflare/workers-rs).

## Issues

If you have any problems with the `worker` crate, please open an issue on the upstream project 

issue tracker on the [`workers-rs` repository](https://github.com/cloudflare/workers-rs).