https://github.com/dario-piotrowicz/wrangler-pages-functions-dev

Vite plugin for handling Pages Functions in dev mode
https://github.com/dario-piotrowicz/wrangler-pages-functions-dev

Last synced: 8 days ago
JSON representation

Vite plugin for handling Pages Functions in dev mode

• Host: GitHub
• URL: https://github.com/dario-piotrowicz/wrangler-pages-functions-dev
• Owner: dario-piotrowicz
• Created: 2024-05-25T17:21:11.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-28T23:40:55.000Z (6 months ago)
• Last Synced: 2024-10-03T07:36:34.930Z (about 1 month ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/wrangler-pages-functions-dev
• Size: 41 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `wrangler-pages-functions-dev`

`wrangler-pages-functions-dev` is a Vite plugin that can be used to handle [Cloudflare Pages Functions](https://developers.cloudflare.com/pages/functions/) during local development.

It can be useful for example when working on a single page application that makes use of Pages Functions.

## Usage

Install the package as a dev dependency alongside wrangler:

```sh

npm i -D wrangler-pages-functions-dev wrangler

```

To use the plugin with `vite dev` simply update your vite config file to include the plugin and to specify which routes it should handle, for example:

```diff

export default defineConfig({

  plugins: [

+    wranglerPagesFunctionsDev({

+      matchRoutes: /api/,

+    }),

    // ...

  ],

})

```

You can preview or deploy you application with `wrangler pages` in the same exact way as you would without this plugin (this plugin only effects `vite dev` everything else works exactly the same as it would otherwise).

## Examples

- [React SPA hello-world example](https://github.com/dario-piotrowicz/wrangler-pages-functions-dev-react-spa-hello-world-example)\

Very minimalistic example that shows how this plugin can be used to locally developer a react SPA applications alongside Pages Functions.