Start from scratch

Last updated Apr 23, 2026 Use Workers Static Assets Instead

You should use Workers Static Assets to host full-stack applications instead of Workers Sites. It has been deprecated in Wrangler v4, and the Cloudflare Vite plugin does not support Workers Sites. Do not use Workers Sites for new projects.

This guide shows how to quickly start a new Workers Sites project from scratch.

Getting started

  1. Ensure you have the latest version of git ↗︎ and Node.js ↗︎ installed.
  2. In your terminal, clone the worker-sites-template starter repository. The following example creates a project called my-site:

sh git clone --depth=1 --branch=wrangler2 https://github.com/cloudflare/worker-sites-template my-site

  1. Run npm install to install all dependencies.
  2. You can preview your site by running the wrangler dev command:

sh wrangler dev

  1. Deploy your site to Cloudflare:

sh npx wrangler deploy

Project layout

The template project contains the following files and directories:

  • public: The static assets for your project. By default it contains an index.html and a favicon.ico.
  • src: The Worker configured for serving your assets. You do not need to edit this but if you want to see how it works or add more functionality to your Worker, you can edit src/index.ts.
  • wrangler.jsonc: The file containing project configuration. The bucket property tells Wrangler where to find the static assets (e.g. site = { bucket = "./public" }).
  • package.json/ package-lock.json: define the required Node.js dependencies.

Customize the wrangler.jsonc file:

  • Change the name property to the name of your project:

jsonc { "$schema": "./node_modules/wrangler/config-schema.json", "name": "my-site" }

toml "$schema" = "./node_modules/wrangler/config-schema.json" name = "my-site"

  • Consider updating compatibility_date to today's date to get access to the most recent Workers features:

jsonc { "compatibility_date": "yyyy-mm-dd" }

toml compatibility_date = "yyyy-mm-dd"

  • Deploy your site to a custom domain that you own and have already attached as a Cloudflare zone:

jsonc { "route": "https://example.com/*" }

toml route = "https://example.com/*"

Note

Refer to the documentation on Routes to configure a route properly.

Learn more about configuring your project.

Was this helpful?

YesNo

On this page

Start from scratch - 图1Docs

{"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/workers/static-assets/#page","headline":"Start from scratch","description":"Create a new Workers Sites project from scratch with Wrangler.","url":"https://developers.cloudflare.com/workers/static-assets/","inLanguage":"en","image":"https://developers.cloudflare.com/workers/configuration/sites/start-from-scratch/og.png?v=cd8ea9ed24d99a3f","dateModified":"2026-04-23","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}}

description: Add static asset serving to an existing Cloudflare Worker using Workers Sites. title: Start from Worker image: https://developers.cloudflare.com/workers/configuration/sites/start-from-worker/og.png?v=7b8a2fcfa39f134a

Skip to content

Documentation Index
Fetch the complete documentation index at: https://developers.cloudflare.com/workers/llms.txt
Use this file to discover all available pages before exploring further.