Skip to content

Commit

Permalink
npx -> npm
Browse files Browse the repository at this point in the history
  • Loading branch information
elithrar committed Oct 21, 2024
1 parent fdce8d2 commit ba4ff2f
Show file tree
Hide file tree
Showing 6 changed files with 102 additions and 1,074 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -170,3 +170,6 @@ dist

.dev.vars
.wrangler/

# macOS
.DS_Store
63 changes: 61 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,69 @@ Read the [announcement blog]() to learn more about what Workflows is and how to

Visit the [get started guide](https://developers.cloudflare.com/workflows/get-started/guide/) for Workflows to create and deploy your first Workflow.

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

```sh
npx create cloudflare@latest workflows-starter -- --template "cloudflare:workflows-starter"
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:

```sh
➜ npm create cloudflare@latest workflows-tutorial -- --template="cloudflare/workflows-starter"

──────────────────────────────────────────────────────────────────────────────────────────────────────────
╭ 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](https://developers.cloudflare.com/workflows/) contains examples, the API reference, and architecture guidance.
Expand Down
130 changes: 15 additions & 115 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit ba4ff2f

Please sign in to comment.