History

Isaac McFadyen 004995eecd Update README.md (#4119 )		2022-08-02 10:26:25 -05:00
..
src	[ci] format	2022-07-27 20:17:38 +00:00
test	chore: skip cloudflare test for now (#4117 )	2022-08-02 10:26:00 -05:00
CHANGELOG.md	[ci] release (#4056 )	2022-07-28 08:17:45 -04:00
package.json	[ci] release (#4056 )	2022-07-28 08:17:45 -04:00
README.md	Update README.md (#4119 )	2022-08-02 10:26:25 -05:00
tsconfig.json	feat: add SSR adaptor for cloudflare pages functions (#3600 )	2022-06-16 10:12:25 -04:00

README.md

@astrojs/cloudflare

An SSR adapter for use with Cloudflare Pages Functions targets. Write your code in Astro/Javascript and deploy to Cloudflare Pages.

In your astro.config.mjs use:

import { defineConfig } from 'astro/config';
import cloudflare from '@astrojs/cloudflare';

export default defineConfig({
  output: 'server',
  adapter: cloudflare()
});

Enabling Preview

In order for preview to work you must install wrangler

$ pnpm install wrangler --save-dev

It's then possible to update the preview script in your package.json to "preview": "wrangler pages dev ./dist"

Streams

Some integrations such as React rely on web streams. Currently Cloudflare Pages functions are in beta and don't support the streams_enable_constructors feature flag.

In order to work around this:

install the "web-streams-polyfill" package
add import "web-streams-polyfill/es2018"; to the top of the front matter of every page which requires streams, such as server rendering a React component.