Remix Compute for Netlify

The Remix Compute for Netlify packages allow you to deploy your Remix apps to Netlify Edge Functions or Netlify Functions.

This project is not a template for Remix apps. It is a set of packages used by the Netlify Remix template.

The project is a pnpm monorepo. Packages are located in the packages directory, and demo sites are in demos. There are three packages:

@netlify/remix-adapter - The Remix adapter for Netlify Functions
@netlify/remix-edge-adapter - The Remix adapter for Netlify Edge Functions
@netlify/remix-runtime - The Remix runtime for Netlify Edge Functions

Hydrogen

Shopify Hydrogen sites are supported and automatically detected. However, only the edge adapter is supported, and only when using Remix Vite.

Development

Installation

corepack enable
pnpm install

This installs all the dependencies for all the packages and builds the @netlify/remix-runtime, @netlify/remix-adapter, and @netlify/remix-edge-adapter packages.

Testing

To build the packages, run the build command.

pnpm run build:packages

Run the build watch command to have packages built when they are changed.

pnpm run build:packages:watch

To run unit tests:

pnpm run test:unit

To run all tests (including linting and typechecking):

pnpm run test

End-to-end integration tests

These tests are meant to be very terse, basic, happy-path "user journey" system tests. These should generally map to user-facing features and should rarely be added to.

Prerequisites:

Netlify CLI installed globally
Install Playwright browsers (it should prompt you automatically the first time):
- pnpm exec playwright install --with-deps

To run end-to-end integration tests:

pnpm run test:e2e

To add a new fixture site called my-fixture: