mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00

History

Matthew Phillips 6fd161d769 Add the `output` option (#4015 ) * Start of work on astroConfig.mode === 'server' * Add tests and more * adapter -> deploy in some places * Add fallback for `adapter` config * Update more tests * Update image tests * Fix clientAddress test * Updates based on PR review * Add a changeset * Update integrations tests + readme * Oops * Remove old option * Rename `mode` to `output` * Update Node adapter test * Update test * fred pass * fred pass * fred pass * fix test Co-authored-by: Fred K. Schott <fkschott@gmail.com>		2022-07-25 00:18:02 -04:00
..
src	Add the `output` option (#4015 )	2022-07-25 00:18:02 -04:00
CHANGELOG.md	[ci] release (#3894 )	2022-07-12 09:08:15 -04:00
package.json	[ci] release (#3894 )	2022-07-12 09:08:15 -04:00
README.md	Add the `output` option (#4015 )	2022-07-25 00:18:02 -04:00
tsconfig.json

README.md

@astrojs/cloudflare

An SSR adapter for use with Cloudflare Pages Functions targets. Write your code in Astro/Node 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.