Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(other-api/adapter): add community adapters #5254

Merged
merged 7 commits into from
Jan 28, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/other-api/adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ order: 2

# Server Adapters

## Official Adapters

Idiomatic Remix apps can generally be deployed anywhere because Remix adapt's the server's request/response to the [Web Fetch API][web-fetch-api]. It does this through adapters. We maintain a few adapters:

- `@remix-run/architect`
Expand All @@ -22,7 +24,11 @@ If you initialized your app with `npx create-remix@latest` with something other

Each adapter has the same API. In the future we may have helpers specific to the platform you're deploying to.

## `createRequestHandler`
### Community Adapters
penx marked this conversation as resolved.
Show resolved Hide resolved

- [remix-google-cloud-functions][remix-google-cloud-functions] - For [Google Cloud][google-cloud-functions] and [Firebase][firebase-functions] functions.
penx marked this conversation as resolved.
Show resolved Hide resolved

### `createRequestHandler`
penx marked this conversation as resolved.
Show resolved Hide resolved

Creates a request handler for your server to serve the app. This is the ultimate entry point of your Remix application.

Expand Down Expand Up @@ -169,3 +175,6 @@ addEventListener("fetch", (event) => {
```

[web-fetch-api]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
[remix-google-cloud-functions]: https://github.com/penx/remix-google-cloud-functions
[google-cloud-functions]: https://cloud.google.com/functions
[firebase-functions]: https://firebase.google.com/docs/functions
6 changes: 6 additions & 0 deletions docs/pages/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ Our [GitHub discussions forum][git-hub-discussions-forum] is a good place to cha

You can find (and create) examples in the [Remix examples repository][the-examples-repository].

## Community Adapters

You can find Community Adapters int the [Adapters Documentation][community-adapters]. If you've written your own, you can [update this list on GitHub][community-adapters-github].
penx marked this conversation as resolved.
Show resolved Hide resolved

## Courses

Here's a list of courses (in no particular order) you can take to help learn Remix:
Expand Down Expand Up @@ -98,3 +102,5 @@ There are Remix Meetups all over the world with thousands of members. Some onlin
[frontend-masters]: https://frontendmasters.com
[remix-fundamentals]: https://frontendmasters.com/courses/remix/
[advanced-remix]: https://frontendmasters.com/courses/advanced-remix/
[community-adapters]: ../other-api/adapter#community-adapters
[community-adapters-github]: https://github.com/remix-run/remix/blob/main/docs/pages/community.md#community-adapters
penx marked this conversation as resolved.
Show resolved Hide resolved