README.md

Cloudflare Workflows

This is the starter template for Workflows, a durable execution engine built on top of Cloudflare Workers.

• Clone this repository to get started with Workflows
• Read the Workflows announcement blog to learn more about what Workflows is and how to build durable, multi-step applications using the Workflows model.
• Review the Workflows developer documentation to dive deeper into the Workflows API and how it works.

Usage

Visit the get started guide for Workflows to create and deploy your first Workflow.

Example

You can create a project using this template by using npm create cloudflare@latest:

npm create cloudflare@latest workflows-starter -- --template "cloudflare/workflows-starter"

This will automatically clone this repository, install the dependencies, and prompt you to optionally deploy:

╭ Create an application with Cloudflare Step 1 of 3
│
├ In which directory do you want to create your application?
│ dir ./workflows-tutorial
│
├ What would you like to start with?
│ category Template from a GitHub repo
│
├ What's the url of git repo containing the template you'd like to use?
│ repository cloudflare/workflows-starter
│
├ Cloning template from: cloudflare/workflows-starter
│
├ template cloned and validated
│
├ Copying template files
│ files copied to project directory
│
├ Installing dependencies
│ installed via `npm install`
│
╰ Application created

╭ Configuring your application for Cloudflare Step 2 of 3
│
├ Installing @cloudflare/workers-types
│ installed via npm
│
├ Adding latest types to `tsconfig.json`
│ added @cloudflare/workers-types/2023-07-01
│
├ Do you want to use git for version control?
│ yes git
│
├ Initializing git repo
│ initialized git
│
├ Committing new files
│ git commit
│
╰ Application configured

╭ Deploy with Cloudflare Step 3 of 3
│
├ Do you want to deploy your application?
│ no deploy via `npm run deploy`
│
╰ Done

────────────────────────────────────────────────────────────
🎉  SUCCESS  Application created successfully!

The Workflows documentation contains examples, the API reference, and architecture guidance.

License

Copyright 2024, Cloudflare. Apache 2.0 licensed. See the LICENSE file for details.