---
title: Start from scratch · Cloudflare Workers docs
description: This guide shows how to quickly start a new Workers Sites project from scratch.
lastUpdated: 2025-02-12T13:41:31.000Z
source_url:
  html: https://a74404c8.preview.developers.cloudflare.com/workers/configuration/sites/start-from-scratch/index.md
  md: https://a74404c8.preview.developers.cloudflare.com/workers/configuration/sites/start-from-scratch/
---

Use Workers Static Assets Instead

You should use [Workers Static Assets](https://developers.cloudflare.com/workers/static-assets/) to host full-stack applications instead of Workers Sites. It has been deprecated in Wrangler v4, and the [Cloudflare Vite plugin](https://developers.cloudflare.com/workers/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](https://git-scm.com/downloads) and [Node.js](https://nodejs.org/en/download/) 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
   ```

3. Run `npm install` to install all dependencies.

4. You can preview your site by running the [`wrangler dev`](https://developers.cloudflare.com/workers/wrangler/commands/#dev) command:

   ```sh
   wrangler dev
   ```

5. 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:

  * wrangler.jsonc

    ```jsonc
    {
      "name": "my-site"
    }
    ```

  * wrangler.toml

    ```toml
    name = "my-site"
    ```

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

  * wrangler.jsonc

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

  * wrangler.toml

    ```toml
    compatibility_date = "yyyy-mm-dd"
    ```

* Deploy your site to a [custom domain](https://developers.cloudflare.com/workers/configuration/routing/custom-domains/) that you own and have already attached as a Cloudflare zone:

  * wrangler.jsonc

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

  * wrangler.toml

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

  Note

  Refer to the documentation on [Routes](https://developers.cloudflare.com/workers/configuration/routing/routes/) to configure a `route` properly.

Learn more about [configuring your project](https://developers.cloudflare.com/workers/wrangler/configuration/).
