/remix-aws

AWS adapter for Remix

Primary LanguageTypeScriptMIT LicenseMIT

Remix AWS

npm version npm install size Known Vulnerabilities

Remix logo

AWS adapters for Remix

🚀 support

  • API gateway v1
  • API gateway v2
  • Application load balancer

Getting started

npm install --save remix-aws
// server.js
import * as build from '@remix-run/dev/server-build'
import {AWSProxy, createRequestHandler} from 'remix-aws'

// Required in Remix v2
import { installGlobals } from '@remix-run/node'
installGlobals()

export const handler = createRequestHandler({
    build,
    mode: process.env.NODE_ENV,
    awsProxy: AWSProxy.APIGatewayV1
})

awsProxy

By default the awsProxy is set to AWSProxy.APIGatewayV2.

Options

  • AWSProxy.APIGatewayV1
  • AWSProxy.APIGatewayV2
  • AWSProxy.ALB
  • AWSProxy.FunctionURL

Notes

split from @remix/architect

As mentioned in #3173 the goal would be to provide an AWS adapter for the community by the community. In doing so the focus will be on AWS integrations and less on Architect. I do think it's added value to provide examples for Architect, AWS SAM, AWS CDK, Serverless,...

info: ALB types vs API gateway v1 types

To do

  • add tests
  • add examples
  • add more documentation